Skip to content

Commit bccb231

Browse files
committed
Remove Quickstart from README
The README on the GitHub repository page reflects the state of the master branch, instead of the stable release. To reduce potential confusion, it's better to keep the README short, and omit the Quickstart content. This content is still available on Read the Docs, and now lives in quickstart.rst itself, instead of being included from the README. The README now consists of the badges, the logo, the usage, and the list of features. Sphinx references are spread out over the README, the Quickstart Guide, and the User Guide, with each of these including references from its predecessors.
1 parent 1f9dd1d commit bccb231

File tree

3 files changed

+200
-204
lines changed

3 files changed

+200
-204
lines changed

README.rst

Lines changed: 0 additions & 200 deletions
Original file line numberDiff line numberDiff line change
@@ -91,202 +91,6 @@ The template supports Python 3.6, 3.7, 3.8, and 3.9.
9191

9292
.. features-end
9393
94-
95-
Quickstart
96-
==========
97-
98-
.. quickstart-begin
99-
100-
Requirements
101-
------------
102-
103-
Install Cookiecutter_:
104-
105-
.. code:: console
106-
107-
$ pipx install cookiecutter
108-
109-
Install Poetry_ by downloading and running get-poetry.py_:
110-
111-
.. _get-poetry.py: https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py
112-
113-
.. code:: console
114-
115-
$ python get-poetry.py
116-
117-
Install Nox_ and nox-poetry_:
118-
119-
.. code:: console
120-
121-
$ pipx install nox
122-
$ pipx inject nox nox-poetry
123-
124-
pipx_ is preferred, but you can also install with ``pip install --user``.
125-
126-
It is recommended to set up Python 3.6, 3.7, 3.8, and 3.9 using pyenv_.
127-
128-
129-
Creating a project
130-
------------------
131-
132-
Generate a Python project:
133-
134-
.. code:: console
135-
136-
$ cookiecutter gh:cjolowicz/cookiecutter-hypermodern-python \
137-
--checkout="2020.11.15"
138-
139-
Change to the root directory of your new project,
140-
and create a Git repository:
141-
142-
.. code:: console
143-
144-
$ git init
145-
$ git add .
146-
$ git commit
147-
148-
149-
Running
150-
-------
151-
152-
Run the command-line interface from the source tree:
153-
154-
.. code:: console
155-
156-
$ poetry install
157-
$ poetry run <project>
158-
159-
Run an interactive Python session:
160-
161-
.. code:: console
162-
163-
$ poetry install
164-
$ poetry run python
165-
166-
167-
Testing
168-
-------
169-
170-
Run the full test suite:
171-
172-
.. code:: console
173-
174-
$ nox
175-
176-
List the available Nox sessions:
177-
178-
.. code:: console
179-
180-
$ nox --list-sessions
181-
182-
Install the pre-commit hooks:
183-
184-
.. code:: console
185-
186-
$ nox -s pre-commit -- install
187-
188-
189-
Continuous Integration
190-
----------------------
191-
192-
GitHub
193-
~~~~~~
194-
195-
1. Sign up at GitHub_.
196-
2. Create an empty repository for your project.
197-
3. Follow the instructions to push an existing repository from the command line.
198-
199-
200-
PyPI
201-
~~~~
202-
203-
1. Sign up at PyPI_.
204-
2. Go to the Account Settings on PyPI,
205-
generate an API token, and copy it.
206-
3. Go to the repository settings on GitHub, and
207-
add a secret named ``PYPI_TOKEN`` with the token you just copied.
208-
209-
210-
TestPyPI
211-
~~~~~~~~
212-
213-
1. Sign up at TestPyPI_.
214-
2. Go to the Account Settings on TestPyPI,
215-
generate an API token, and copy it.
216-
3. Go to the repository settings on GitHub, and
217-
add a secret named ``TEST_PYPI_TOKEN`` with the token you just copied.
218-
219-
220-
Codecov
221-
~~~~~~~
222-
223-
1. Sign up at Codecov_.
224-
2. Install their GitHub app.
225-
226-
227-
Read the Docs
228-
~~~~~~~~~~~~~
229-
230-
1. Sign up at `Read the Docs`_.
231-
2. Import your GitHub repository, using the button *Import a Project*.
232-
3. Install the GitHub webhook,
233-
using the button *Add integration*
234-
on the *Integrations* tab
235-
in the *Admin* section of your project
236-
on Read the Docs.
237-
238-
239-
Releasing
240-
---------
241-
242-
Releases are triggered by a version bump on the default branch.
243-
It is recommended to do this in a separate pull request:
244-
245-
1. Switch to a branch.
246-
2. Bump the version using `poetry version`_.
247-
3. Commit and push to GitHub.
248-
4. Open a pull request.
249-
5. Merge the pull request.
250-
251-
.. _poetry version: https://python-poetry.org/docs/cli/#version
252-
253-
The Release workflow performs the following automated steps:
254-
255-
- Build and upload the package to PyPI.
256-
- Apply a version tag to the repository.
257-
- Publish a GitHub Release.
258-
259-
Release notes are populated with the titles and authors of merged pull requests.
260-
You can group the pull requests into separate sections
261-
by applying labels to them, like this:
262-
263-
.. table-release-drafter-sections-begin
264-
265-
.. table::
266-
:class: hypermodern-table
267-
:widths: auto
268-
269-
=================== ============================
270-
Pull Request Label Section in Release Notes
271-
=================== ============================
272-
``breaking`` 💥 Breaking Changes
273-
``enhancement`` 🚀 Features
274-
``removal`` 🔥 Removals and Deprecations
275-
``bug`` 🐞 Fixes
276-
``performance`` 🐎 Performance
277-
``testing`` 🚨 Testing
278-
``ci`` 👷 Continuous Integration
279-
``documentation`` 📚 Documentation
280-
``refactoring`` 🔨 Refactoring
281-
``style`` 💄 Style
282-
``dependencies`` 📦 Dependencies
283-
=================== ============================
284-
285-
286-
.. table-release-drafter-sections-end
287-
288-
.. quickstart-end
289-
29094
.. references-begin
29195
29296
.. _Bandit: https://github.com/PyCQA/bandit
@@ -297,7 +101,6 @@ by applying labels to them, like this:
297101
.. _Coverage.py: https://coverage.readthedocs.io/
298102
.. _Dependabot: https://dependabot.com/
299103
.. _Flake8: http://flake8.pycqa.org
300-
.. _GitHub: https://github.com/
301104
.. _GitHub Actions: https://github.com/features/actions
302105
.. _Hypermodern Python: https://medium.com/@cjolowicz/hypermodern-python-d44485d9d769
303106
.. _Nox: https://nox.thea.codes/
@@ -313,10 +116,7 @@ by applying labels to them, like this:
313116
.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
314117
.. _mypy: http://mypy-lang.org/
315118
.. _napoleon: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
316-
.. _nox-poetry: https://nox-poetry.readthedocs.io/
317-
.. _pipx: https://pipxproject.github.io/pipx/
318119
.. _pre-commit: https://pre-commit.com/
319-
.. _pyenv: https://github.com/pyenv/pyenv
320120
.. _pytest: https://docs.pytest.org/en/latest/
321121
.. _sphinx-click: https://sphinx-click.readthedocs.io/
322122
.. _xdoctest: https://github.com/Erotemic/xdoctest

docs/guide.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2372,7 +2372,7 @@ Release notes are populated with the titles and authors of merged pull requests.
23722372
You can group the pull requests into separate sections
23732373
by applying labels to them, like this:
23742374

2375-
.. include:: ../README.rst
2375+
.. include:: quickstart.rst
23762376
:start-after: table-release-drafter-sections-begin
23772377
:end-before: table-release-drafter-sections-end
23782378

@@ -2617,6 +2617,10 @@ __ https://cjolowicz.github.io/posts/hypermodern-python-01-setup/
26172617
:start-after: references-begin
26182618
:end-before: references-end
26192619

2620+
.. include:: ./quickstart.rst
2621+
:start-after: quickstart-references-begin
2622+
:end-before: quickstart-references-end
2623+
26202624
.. _Calendar Versioning: https://calver.org
26212625
.. _GitHub Release: https://help.github.com/en/github/administering-a-repository/about-releases
26222626
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python

0 commit comments

Comments
 (0)