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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,5 +78,6 @@ The rules for this file:

### Removed
<!-- Removed features -->
- Unused `_version.py` references (PR #160)
- Unused files from MolSSI
- `canvas` entrypoint (Issue #40, PR #45)
1 change: 0 additions & 1 deletion docs/scripts/file_descriptions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/source/customising/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <versioning>`) 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 <https://docs.mdanalysis.org/stable/documentation_pages/analysis/base.html>`_.
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`.
Expand Down
18 changes: 9 additions & 9 deletions docs/source/customising/packaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <versioning>`.
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 <version>`.
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 <https://pypi.org/>`_ or `conda-forge <https://conda-forge.org/>`_ to
Expand All @@ -43,23 +43,23 @@ 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

$ cd <my_package_directory>
$ 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

Expand Down
2 changes: 0 additions & 2 deletions {{cookiecutter.repo_name}}/.codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,3 @@ comment:
behavior: default
flags: null
paths: null
ignore:
- "{{cookiecutter.repo_name}}/_version.py"
1 change: 0 additions & 1 deletion {{cookiecutter.repo_name}}/.gitattributes

This file was deleted.

Loading