Skip to content

Commit d7b3e9c

Browse files
authored
Fix badge rendering (#13)
* Switch to poetry. * Fix env and pytest call. * Call flake8 and black with poetry. * Run flake8 just on project files. * Windows compatible. * Remove venv setup. * Update pre-commit hooks. * Testing hooks. * Test hooks. * Test hooks. * Update prehooks. * Format. * Update docs. * Remove hatchling toml. * Fix badge rendering. * Update README with additional tools and technologies. * New line. * New line. * Revert. * New line.
1 parent 209a041 commit d7b3e9c

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ pydevtips: Python Development Tips
77
:alt: Documentation Status
88

99

10-
.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/python.yml/badge.svg
11-
:target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/python.yml
10+
.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/poetry.yml/badge.svg
11+
:target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/poetry.yml
1212
:alt: Unit tests and formatting
1313

1414
.. image:: https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white
@@ -25,12 +25,12 @@ pydevtips: Python Development Tips
2525
.. <strike>
2626
2727
.. .. |se| raw:: html
28-
2928
.. </strike>
3029
30+
|
3131
32-
Reproducibility is important for software: *if it's not reproducible,
33-
it's not useful*. Even if you don't plan on sharing your code, imagine
32+
Reproducibility is important for software: *if it's not reproducible, it's not useful*.
33+
Even if you don't plan on sharing your code, imagine
3434
coming back to a project after a few weeks, or having
3535
to install it on a new machine. You'll be all the more thankful to your
3636
past self if you have a clear way to install and run your code.
@@ -55,13 +55,13 @@ choose the features that you like. This flexibility is one of the best
5555
(and worst parts) of open source. Some of the things we cover:
5656

5757
* Packaging and distribution with `Poetry <https://python-poetry.org/>`_.
58-
* Virtual environments.
59-
* Version control.
60-
* Reproducible examples.
61-
* Documentation.
62-
* Code formatting.
63-
* Unit tests and continuous integration.
64-
* Remove development.
58+
* Virtual environments with `Conda <https://docs.conda.io/en/latest/>`_ and `virtualenv <https://virtualenv.pypa.io/en/latest/>`_.
59+
* Version control with Git/GitHub.
60+
* Reproducible examples with `Hydra <https://hydra.cc/>`_.
61+
* Documentation with `Sphinx <https://www.sphinx-doc.org/en/master/>`_.
62+
* Code formatting with Black, Flake8, and isort.
63+
* Unit tests and continuous integration with `pytest <https://docs.pytest.org/en/stable/>`_ and `GitHub Actions <https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python>`_.
64+
* Remote development with `VS Code <https://code.visualstudio.com/>` and `SSH <https://en.wikipedia.org/wiki/Secure_Shell>`_.
6565

6666
The accompanying
6767
`slides <https://docs.google.com/presentation/d/1D1_JywMl2rjaeuVzpykPBOJsDIuwQKGOJB4EFZjej2s/edit#slide=id.g2eaa4b61f15_0_1346>`__

docs/source/badges.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ You can also create `badges from GitHub Actions <https://docs.github.com/en/acti
2121

2222
.. code:: rst
2323
24-
.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/python.yml/badge.svg
25-
:target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/python.yml
24+
.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/poetry.yml/badge.svg
25+
:target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/poetry.yml
2626
:alt: Unit tests and formatting
2727
28-
.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/python.yml/badge.svg
29-
:target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/python.yml
28+
.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/poetry.yml/badge.svg
29+
:target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/poetry.yml
3030
:alt: Unit tests and formatting
3131

3232
Finally, you can use `Badgen <https://badgen.net/>`__ or `Shields.io <https://shields.io/badges>`__ to create custom badges.

0 commit comments

Comments
 (0)