Skip to content

Update packaging #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Oct 22, 2024
Merged

Update packaging #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
8a94c15
Switch to poetry.
ebezzam Oct 21, 2024
f55ad44
Fix env and pytest call.
ebezzam Oct 21, 2024
9290bd3
Call flake8 and black with poetry.
ebezzam Oct 21, 2024
4d9aa8a
Run flake8 just on project files.
ebezzam Oct 21, 2024
bfea193
Windows compatible.
ebezzam Oct 21, 2024
08ce67c
Remove venv setup.
ebezzam Oct 21, 2024
5005b96
Update pre-commit hooks.
ebezzam Oct 21, 2024
3f57455
Testing hooks.
ebezzam Oct 21, 2024
bfb803b
Test hooks.
ebezzam Oct 21, 2024
9d40d10
Test hooks.
ebezzam Oct 21, 2024
0c0a9bc
Update prehooks.
ebezzam Oct 21, 2024
fdb27c6
Format.
ebezzam Oct 22, 2024
3a50990
Update docs.
ebezzam Oct 22, 2024
e33cd9f
Remove hatchling toml.
ebezzam Oct 22, 2024
7991a0b
Merge branch 'main' into update-packaging
ebezzam Oct 22, 2024
b858706
Fix badge rendering.
ebezzam Oct 22, 2024
ea2aad0
Update README with additional tools and technologies.
ebezzam Oct 22, 2024
6fc3f0f
New line.
ebezzam Oct 22, 2024
5d14dd3
New line.
ebezzam Oct 22, 2024
06e5bb9
Revert.
ebezzam Oct 22, 2024
3490700
New line.
ebezzam Oct 22, 2024
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
24 changes: 12 additions & 12 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ pydevtips: Python Development Tips
:alt: Documentation Status


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

.. image:: https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white
Expand All @@ -25,12 +25,12 @@ pydevtips: Python Development Tips
.. <strike>

.. .. |se| raw:: html

.. </strike>

|

Reproducibility is important for software: *if it's not reproducible,
it's not useful*. Even if you don't plan on sharing your code, imagine
Reproducibility is important for software: *if it's not reproducible, it's not useful*.
Even if you don't plan on sharing your code, imagine
coming back to a project after a few weeks, or having
to install it on a new machine. You'll be all the more thankful to your
past self if you have a clear way to install and run your code.
Expand All @@ -55,13 +55,13 @@ choose the features that you like. This flexibility is one of the best
(and worst parts) of open source. Some of the things we cover:

* Packaging and distribution with `Poetry <https://python-poetry.org/>`_.
* Virtual environments.
* Version control.
* Reproducible examples.
* Documentation.
* Code formatting.
* Unit tests and continuous integration.
* Remove development.
* Virtual environments with `Conda <https://docs.conda.io/en/latest/>`_ and `virtualenv <https://virtualenv.pypa.io/en/latest/>`_.
* Version control with Git/GitHub.
* Reproducible examples with `Hydra <https://hydra.cc/>`_.
* Documentation with `Sphinx <https://www.sphinx-doc.org/en/master/>`_.
* Code formatting with Black, Flake8, and isort.
* 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>`_.
* Remote development with `VS Code <https://code.visualstudio.com/>` and `SSH <https://en.wikipedia.org/wiki/Secure_Shell>`_.

The accompanying
`slides <https://docs.google.com/presentation/d/1D1_JywMl2rjaeuVzpykPBOJsDIuwQKGOJB4EFZjej2s/edit#slide=id.g2eaa4b61f15_0_1346>`__
Expand Down
8 changes: 4 additions & 4 deletions docs/source/badges.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ You can also create `badges from GitHub Actions <https://docs.github.com/en/acti

.. code:: rst

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

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

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