Merge pull request #6 from pdssp/poetry

Poetry

Author: J-Christophe

tests/test_generation.py

@@ -27,7 +27,6 @@ def test_project_structure(generate_project):
         "pyproject.toml",
         "Makefile",
         "LICENSE",
-        "Dockerfile",
         "CONTRIBUTING.rst",
         "CHANGELOG",
         "AUTHORS.rst",
@@ -97,7 +96,7 @@ def test_license(generate_project):
 
 def test_Dockerfile(generate_project):
     """Check the Dockerfile is correctly generated."""
-    readme_path = os.path.join(generate_project, "testproject", "Dockerfile")
+    readme_path = os.path.join(generate_project, "testproject", "docker", "Dockerfile")
 
     with open(readme_path, 'r') as readme_file:
         content = readme_file.read()

{{cookiecutter.project_slug}}/.flake8

@@ -1,5 +1,5 @@
 [flake8]
-ignore = E203, E266, E501, W503, F403, F401
+ignore = E203, E266, E501, W503, F403, F401, E402
 max-line-length = 79
 max-complexity = 18
 select = B,C,E,F,W,T4,B9

{{cookiecutter.project_slug}}/.github/workflows/test-and-deploy.yml

@@ -37,5 +37,5 @@ jobs:
       uses: peaceiris/actions-gh-pages@v3
       if: github.ref == 'refs/heads/main'
       with:
-        github_token: <TODO: MY_GITHUB_token>
-        publish_dir: docs/build/html/
+        github_token: ${{ '{{ secrets.GITHUB_TOKEN }}' }}
+        publish_dir: docs/build/html/

{{cookiecutter.project_slug}}/.gitignore

@@ -128,6 +128,8 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-{{ cookiecutter.project_slug }}-env/
+.{{ cookiecutter.project_slug }}
 
-docs/build/
+docs/build/
+
+**/tests/msap_data/

{{cookiecutter.project_slug}}/.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -16,17 +16,22 @@ repos:
       - id: name-tests-test
       - id: requirements-txt-fixer
       - id: pretty-format-json
-      - id: fix-encoding-pragma
+        exclude: ^update/cookiecutter_answers\.json$
+      #- id: fix-encoding-pragma
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.4.0
+    rev: v3.15.0
     hooks:
       - id: reorder-python-imports
-  - repo: https://github.com/psf/black.git
-    rev: 22.10.0
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 25.9.0
     hooks:
       - id: black
         language_version: python3
   - repo: https://github.com/pycqa/flake8
-    rev: 3.7.9
+    rev: 7.3.0
     hooks:
       - id: flake8
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.20.0
+    hooks:
+      - id: pyupgrade

{{cookiecutter.project_slug}}/.pypirc

@@ -10,4 +10,4 @@ Development Lead
 Contributors
 ------------
 
-None yet.
+None yet.

{{cookiecutter.project_slug}}/.travis.yml

@@ -1,3 +1,3 @@
 =========
 Changelog
-=========
+=========

{{cookiecutter.project_slug}}/AUTHORS.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/pdssp/{{ cookiecutter.project_slug }}/issues.
+Report bugs at {{ cookiecutter.project_url }}/issues.
 
 If you are reporting a bug, please include:
 
@@ -26,13 +26,13 @@ If you are reporting a bug, please include:
 Fix Bugs
 ~~~~~~~~
 
-Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+Look through the Gitlab issues for bugs. Anything tagged with "bug" and "help
 wanted" is open to whoever wants to implement it.
 
 Implement Features
 ~~~~~~~~~~~~~~~~~~
 
-Look through the GitHub issues for features. Anything tagged with "enhancement"
+Look through the Gitlab issues for features. Anything tagged with "enhancement"
 and "help wanted" is open to whoever wants to implement it.
 
 Write Documentation
@@ -45,7 +45,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/pdssp/{{ cookiecutter.project_slug }}/issues.
+The best way to send feedback is to file an issue at {{ cookiecutter.project_url }}/issues.
 
 If you are proposing a feature:
 
@@ -59,16 +59,17 @@ Get Started!
 
 Ready to contribute? Here's how to set up `{{ cookiecutter.project_slug }}` for local development.
 
-1. Fork the `{{ cookiecutter.project_slug }}` repo on GitHub.
+1. Fork the `{{ cookiecutter.project_slug }}` repo on Gitlab.
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/{{ cookiecutter.project_slug }}.git
+    $ git clone {{ cookiecutter.project_url }}.git
 
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+3. Install your local copy into a virtualenv. Assuming you have virtualenv installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv {{ cookiecutter.project_slug }}
     $ cd {{ cookiecutter.project_slug }}/
-    $ python setup.py develop
+    $ make prepare-dev
+    $ source .{{ cookiecutter.project_slug }}/
+    $ make install-dev
 
 4. Create a branch for local development::
 
@@ -79,19 +80,18 @@ Ready to contribute? Here's how to set up `{{ cookiecutter.project_slug }}` for
 5. When you're done making changes, check that your changes pass flake8 and the
    tests, including testing other Python versions with tox::
 
-    $ flake8 {{ cookiecutter.project_slug }} tests
-    $ python setup.py test or pytest
+    $ make lint
+    $ make tests
     $ tox
 
-   To get flake8 and tox, just pip install them into your virtualenv.
 
-6. Commit your changes and push your branch to GitHub::
+6. Commit your changes and push your branch to Gitlab::
 
     $ git add .
     $ git commit -m "Your detailed description of your changes."
     $ git push origin name-of-your-bugfix-or-feature
 
-7. Submit a pull request through the GitHub website.
+7. Submit a pull request through the Gitlab website.
 
 Pull Request Guidelines
 -----------------------
@@ -108,7 +108,8 @@ Tips
 
 To run a subset of tests::
 
-$ pytest tests.test_{{ cookiecutter.project_slug }}
+    $ pytest tests.test_{{ cookiecutter.project_slug }}
+
 
 Deploying
 ---------
@@ -117,4 +118,4 @@ A reminder for the maintainers on how to deploy.
 Make sure all your changes are committed.
 Then run::
 
-    git tag -a v1.4.0 -m "my version 1.4.0"
+    git tag -a v1.4.0 -m "my version 1.4.0"