diff --git a/CHANGELOG.md b/CHANGELOG.md index c8cac3ac..c87f43bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -78,5 +78,6 @@ The rules for this file: ### Removed +- Unused `_version.py` references (PR #160) - Unused files from MolSSI - `canvas` entrypoint (Issue #40, PR #45) diff --git a/docs/scripts/file_descriptions.yaml b/docs/scripts/file_descriptions.yaml index 53924c5c..deab2919 100644 --- a/docs/scripts/file_descriptions.yaml +++ b/docs/scripts/file_descriptions.yaml @@ -31,7 +31,6 @@ readthedocs.yaml: Settings for ReadTheDocs # cookie package_name: - _version.py: Automatic version control with Versioneer data: __description: Sample additional data (non-code) which can be packaged files.py: Recommended file for resolving data file names diff --git a/docs/source/customising/code.rst b/docs/source/customising/code.rst index d20b7a92..16a4ed60 100644 --- a/docs/source/customising/code.rst +++ b/docs/source/customising/code.rst @@ -6,13 +6,14 @@ Making and pushing changes to your code Now you should go forth and code! Your project's code will live in the ``{package_name}/`` directory. -A basic ``__init__.py`` file (which :ref:`sets the version `) as -been pre-generated, along with several subpackages (and accompanying (empty) +A basic ``__init__.py`` file (which defines ``__version__`` from installed +package metadata; see :ref:`version`) has been pre-generated, along with several +subpackages (and accompanying (empty) ``__init__.py``): * ``analysis/``: If you chose to include a template analysis class when running the cookiecutter, that class will appear in - ``{package_name}/anaylsis/{template_analysis_class}.py``. This class is based + ``{package_name}/analysis/{template_analysis_class}.py``. This class is based on `MDAnalysis AnalysisBase `_. Comments in file should help you as you customise this class for your analysis. * ``tests/``: where your code's unit tests will live. See :ref:`writing-tests`. diff --git a/docs/source/customising/packaging.rst b/docs/source/customising/packaging.rst index 917db594..b8883d2f 100644 --- a/docs/source/customising/packaging.rst +++ b/docs/source/customising/packaging.rst @@ -8,15 +8,15 @@ Packaging A ``pyproject.toml`` file has been created by the cookiecutter to allow your code to be packaged and installed by users. This file has been automatically set up with relevant meta information, dependencies (both core and optional -dependencies for tests and documentaiton), and settings for additional features -including versioningit for :ref:`versioning your code `. -You can edit this file to alter and of this information as appropriate. +dependencies for tests and documentation), and settings for additional features +including `versioningit`_ for :ref:`versioning your code `. +You can edit this file to alter any of this information as appropriate. A ``MANIFEST.in`` file is also created to identify additional files included -when packaging your code (e.g., additional comminity information like the +when packaging your code (e.g., additional community information like the Code of Conduct). -Includion of ``pyproject.toml`` should mean your code is installable from GitHub. +Inclusion of ``pyproject.toml`` should mean your code is installable from GitHub. It is also a good idea to upload your package onto a package repository such as `PyPI `_ or `conda-forge `_ to @@ -43,7 +43,7 @@ The ``cookiecutter`` uses `versioningit`_ to automatically determine your package's version based on git tags. By default, the initial version has been set to ``0.0.0``. -You can install versioningit_ to check the current versioningit output from commandline: +You can install `versioningit`_ to check the current versioningit output from commandline: .. code-block:: bash @@ -51,15 +51,15 @@ You can install versioningit_ to check the current versioningit output from comm $ versioningit . 0.0.0 -As you add commits, the versioning will automatically update with -the commit hashes: +After additional commits past that tag, the template's format rules produce a +local version segment (``+…``), for example: .. code-block:: bash $ versioningit . 0.0.0+1.g58bcaff -To tag a version, use the following command: +To tag a new release, use the following command: .. code-block:: bash diff --git a/{{cookiecutter.repo_name}}/.codecov.yml b/{{cookiecutter.repo_name}}/.codecov.yml index d16479f9..03d22686 100644 --- a/{{cookiecutter.repo_name}}/.codecov.yml +++ b/{{cookiecutter.repo_name}}/.codecov.yml @@ -12,5 +12,3 @@ comment: behavior: default flags: null paths: null -ignore: - - "{{cookiecutter.repo_name}}/_version.py" diff --git a/{{cookiecutter.repo_name}}/.gitattributes b/{{cookiecutter.repo_name}}/.gitattributes deleted file mode 100644 index bc5ae9ec..00000000 --- a/{{cookiecutter.repo_name}}/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -{{cookiecutter.repo_name}}/_version.py export-subst