Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/python_analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ jobs:
with:
package-manager: 'conda'
app-name: 'surface_apps'
python-version: '3.10'
python-version: '3.12'
call-workflow-pytest:
name: Pytest
uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-pytest.yml@main
with:
package-manager: 'conda'
python-versions: '["3.10", "3.11", "3.12"]'
python-versions: '["3.12", "3.13"]'
os: '["ubuntu-latest", "windows-latest"]'
cache-number: 1
codecov-reference-python-version: '3.10'
codecov-reference-python-version: '3.12'
codecov-reference-os: '["windows-latest"]'
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
4 changes: 2 additions & 2 deletions .github/workflows/python_deploy_dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-publish_rattler_package.yml@main
with:
package-name: 'surface-apps'
python-version: '3.10'
python-version: '3.12'
source-repo-names: '["public-noremote-conda-dev"]'
conda-channels: '["conda-forge"]'
publish-repo-names: '["public-noremote-conda-dev"]'
Expand All @@ -30,7 +30,7 @@ jobs:
package-manager: 'poetry'
package-name: 'surface-apps'
version-tag: ${{ github.ref_name }}
python-version: '3.10'
python-version: '3.12'
virtual-repo-names: '["public-pypi-dev", "test-pypi"]'
secrets:
JFROG_ARTIFACTORY_URL: ${{ secrets.JFROG_ARTIFACTORY_URL }}
Expand Down
7 changes: 4 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

default_language_version:
python: python3
python: python3.12
exclude: ^docs/(conf.py|_ext/)
default_stages: [pre-commit,pre-push]
fail_fast: false
Expand All @@ -16,7 +16,7 @@ repos:
hooks:
- id: poetry-check
- repo: https://github.com/hadialqattan/pycln
rev: v2.5.0
rev: v2.6.0
hooks:
- id: pycln
args: [--config=pyproject.toml]
Expand All @@ -36,9 +36,10 @@ repos:
hooks:
- id: mypy
additional_dependencies: [
numpy==1.26.*,
numpy==2.4.*,
types-toml,
types-PyYAML,
pydantic==2.12.*,
tomli # to read config from pyproject.toml
]
exclude: ^(docs|surface_apps-assets)/
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
Expand Down
42 changes: 11 additions & 31 deletions README-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,46 +17,26 @@ After you have cloned the Git repository, you will need to:


Create the Conda environment lock files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------
First, create the Conda environment lock files (``*.conda.lock.yml``) for the dependencies defined
in `pyproject.toml`_. From the root of the project, run the command::

First, you need to create the Conda environment lock files (``*.conda.lock.yml``) for the dependencies defined
in `pyproject.toml`_.
$ deps-lock

.. note::
As a prerequisite, you need to install some packages in your base Conda environment. To do so,
simply execute ``devtools\setup-conda-base.bat``.

Then, to create the Conda environment lock files, execute ``devtools\run_conda_lock.bat``,
or run from command line::

$ (base) python devtools/run_conda_lock.py

It will create or update ``.conda.lock.yml`` files in the ``environments`` folder:
It will create or replace the ``*.conda.lock.yml`` files in the ``environments`` folder:
one for runtime dependencies, and one for development dependencies (with the ``-dev`` suffix),
for each combinations of Python versions and platforms.

The platforms are specified in ``conda-lock`` section of the ``pyproject.toml`` file:

.. code-block:: toml

[tool.conda-lock]
platforms = ['win-64', 'linux-64']

The python versions are specified at the beginning of the ``devtools/run_conda_lock.py`` file:

.. code-block:: python

_python_versions = ["3.10", "3.11"]
for each combinations of Python versions and platforms
(platforms are specified in ``conda-lock`` section of the ``pyproject.toml``).

The ``Install_or_Update.bat`` and the ``setup-dev.bat`` will use them to install the environment.
These files will be used by installation script and to create the development environment.


Install the Conda environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-----------------------------

For development, you need a **Conda** environments. you can install it running the ``setup-dev.bat`` or::
For development, you need a **Conda** environment. From the root of the project, run the command::

$ [path\to\surface-apps]\devtools\setup-dev.bat
$ create-dev-env

This command install a local environment at the base of your repository: ``.conda-env``.
This environment should automatically be recognized by the Conda installation.
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Documentation

Installation
^^^^^^^^^^^^
**surface-apps** is currently written for Python 3.10 or higher.
**surface-apps** is currently written for Python 3.12 or higher.

Install Conda
-------------
Expand Down
3 changes: 1 addition & 2 deletions deps-lock-config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
include_dev: True
py_versions:
- "3.10"
- "3.11"
- "3.12"
- "3.13"
6 changes: 5 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,12 @@
# The full version, including alpha/beta/rc tags.
release = version("surface-apps")
# The shorter X.Y.Z version.
version = Version(release).base_version
pep_version = Version(release)
if pep_version.is_postrelease:
release = pep_version.base_version

# The short X.Y.Z version.
version = Version(release).base_version
Comment thread
domfournier marked this conversation as resolved.

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
3 changes: 3 additions & 0 deletions environments/env-python-3.13.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dependencies:
- python=3.13.*
- pip
169 changes: 0 additions & 169 deletions environments/py-3.10-linux-64-dev.conda.lock.yml

This file was deleted.

Loading
Loading