Skip to content
Merged
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
34 changes: 20 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,36 @@ Python project using simple setuptools project config; note package
data, scripts, entry points, etc, **all still work** using pyproject.toml
per `setuptools documentation`_.

To create a new repository using this template, click the button labeled
**Use this template** and select **Create a new repository**.

|ci| |wheels| |bandit| |release|

|pre| |cov| |pylint|

|tag| |license| |reuse| |python|

To use this template, replace the example project name with your own:
After creating your repository, replace the example project name "simple"
with your own:

* change the project name at the top of ``pyproject.toml``
* change the project name in ``docs/source/conf.py`` *and* ``docs/source/index.rst``
* change the author details in ``pyproject.toml`` *and* ``docs/source/conf.py``
* change the package directory name under the ``src`` folder
* change the github URL paths in ``pyproject.toml``

Make a ``badges`` branch
------------------------

Create an orphan branch for Pylint and Coverage workflows. In a fresh
checkout, run the following commands::

$ git checkout --orphan badges
$ git reset --hard
$ git commit --allow-empty -m "Initializing badges branch"
$ git push origin badges
$ git checkout main


.. _setuptools documentation: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

Expand Down Expand Up @@ -79,19 +95,6 @@ extra features:
status checks


Make a ``badges`` branch
------------------------

Create an orphan branch for Pylint and Coverage workflows. In a fresh
checkout, run the following commands::

$ git checkout --orphan badges
$ git reset --hard
$ git commit --allow-empty -m "Initializing badges branch"
$ git push origin badges
$ git checkout main


Dev tools
=========

Expand Down Expand Up @@ -141,6 +144,9 @@ To build/lint the api docs, use the following tox commands:
* ``tox -e cdocs`` run ``make clean`` in the docs build


Gitchangelog
------------

We use gitchangelog_ to generate a changelog and/or release notes, as
well as the gitchangelog message format to help it categorize/filter
commits for tidier output. Please use the appropriate ACTION modifiers
Expand Down