You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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.
@@ -25,12 +25,12 @@ pydevtips: Python Development Tips
25
25
.. <strike>
26
26
27
27
.. .. |se| raw:: html
28
-
29
28
.. </strike>
30
29
30
+
|
31
31
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
34
34
coming back to a project after a few weeks, or having
35
35
to install it on a new machine. You'll be all the more thankful to your
36
36
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
55
55
(and worst parts) of open source. Some of the things we cover:
56
56
57
57
* 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>`_.
0 commit comments