Skip to content

Commit

Permalink
update cookiecutter and fix packaging config
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeitsperre committed Nov 23, 2023
1 parent b2f12d3 commit 64119f1
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/Ouranosinc/cookiecutter-pypackage",
"commit": "e528361615f8bb4b886206b9cd49ffda76c45b45",
"commit": "de751c55cd9a5df586e3d961535292cfb73e0397",
"checkout": null,
"context": {
"cookiecutter": {
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Ready to contribute? Here's how to set up ``figanos`` for local development for

$ mamba env create -f environment-dev.yml
$ conda activate figanos
$ flit install --symlink .
$ flit install --symlink

#. To ensure a consistent style, please install the pre-commit hooks to your repo::

Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ release: dist ## package and upload a release
python -m flit publish dist/*

install: clean ## install the package to the active Python's site-packages
python -m flit install .
python -m flit install

dev: clean ## install the package to the active Python's site-packages
python -m flit install --symlink .
python -m flit install --symlink
8 changes: 5 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,14 @@ Then you can create the environment and install the package:
.. code-block:: console
$ cd figanos
$ conda env create -f environment.yml
$ conda env create -f environment-dev.yml
Finally, perform an `--editable` install of figanos:
Finally, perform an `--symlink` install of figanos:

.. code-block:: console
$ python -m pip install .
$ flit install --symlink
# Or
$ make dev
.. _Github repo: https://github.com/Ouranosinc/figanos
1 change: 0 additions & 1 deletion environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ dependencies:
- sphinx >=6.2.0
- sphinx-autoapi
- sphinx-book-theme >=1.0.0
- sphinx-click
- sphinx-codeautolink
- sphinx-copybutton
- sphinxcontrib-napoleon
36 changes: 14 additions & 22 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,13 @@ docs = [
"ipython",
"jupyter_client",
"nbsphinx",
"sphinx-click",
"sphinx-codeautolink",
"sphinx-copybutton",
"sphinx>=6.2.0",
"sphinx-book-theme>=1.0",
"sphinxcontrib-napoleon"
]

[project.scripts]
figanos = "figanos.cli:cli"

[project.urls]
"Homepage" = "https://figanos.readthedocs.io/"
"Changelog" = "https://figanos.readthedocs.io/en/stable/changes.html"
Expand Down Expand Up @@ -143,39 +139,35 @@ include = [
"CHANGES.rst",
"CONTRIBUTING.rst",
"LICENSE",
"Makefile",
"README.rst",
"docs/**/*.gif",
"docs/**/*.jpg",
"docs/**/*.png",
"docs/**/*.rst",
"docs/*.rst",
"docs/Makefile",
"docs/_static/_images/*.gif",
"docs/_static/_images/*.jpg",
"docs/_static/_images/*.png",
"docs/_static/_images/*.rst",
"docs/conf.py",
"docs/make.bat",
"setup.cfg",
"docs/notebooks/.ipynb",
"environment-docs.yml",
"environment-dev.yml",
"tests/*.py",
"figanos/**/*.json",
"figanos/**/*.mplstyle",
"figanos/**/*.png",
"figanos/**/*.py",
"figanos/**/*.txt",
"figanos/**/*.yml"
"figanos",
"tox.ini"
]
exclude = [
"**/*.py[co]",
"**/__pycache__",
"*.py[co]",
"__pycache__",
".coveralls.yml",
".editorconfig",
".flake8",
".gitignore",
".pre-commit-config.yaml",
".readthedocs.yml",
".yamllint.yaml",
"Makefile",
"docs/modules.rst",
"docs/figanos*.rst",
"environment-docs.yml",
"environment-dev.yml",
"tox.ini"
"docs/figanos*.rst"
]

[tool.isort]
Expand Down

0 comments on commit 64119f1

Please sign in to comment.