https://github.com/phohenecker/rtd-test-2

https://github.com/phohenecker/rtd-test-2

Last synced: about 6 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/phohenecker/rtd-test-2
• Owner: phohenecker
• License: other
• Created: 2024-03-08T13:35:26.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-08T13:48:27.000Z (8 months ago)
• Last Synced: 2024-03-08T14:48:03.580Z (8 months ago)
• Language: Python
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Python Library: `myrtdtestpkg` 🤩

========================================================================================================================

🧐 About

------------------------------------------------------------------------------------------------------------------------

Just a test.

🏁 Getting Started

------------------------------------------------------------------------------------------------------------------------

The repository uses [`just`](https://github.com/casey/just) (a build tool like `Makefile`) to automate common tasks such

as testing, building, etc.

To list all available recipes, run the following command in the project directory:

```bash

$ just -l

Available recipes:

    build-docs                 # Builds the documentation.

    build-library              # Builds the Python library.

    clean                      # Cleans up all generated files.

    print-version              # Prints the current version of the Python library.

    publish-library            # Builds and publishes the Python library.

    test                       # Runs all unit tests in the test directory.

    test-with-coverage         # Runs all unit tests in the test directory with coverage.

    update-version-to-snapshot # Updates the current version of the Python library to a snapshot version.

```

Furthermore, [Poetry](https://python-poetry.org/) is used to manage dependencies, which provides a virtualenv

environment that readily contains all dependencies required for development, testing, and building.

> ☝️You have to run `poetry install` (in the project root) after cloning this repository for the environment to be

> created.

To use the environment from the shell, run either `poetry run ...` to execute a single command or `poetry shell` to

permanently activate the environment. (Notice that all `just` recipes take care of this automatically.)

✍️ Authors

------------------------------------------------------------------------------------------------------------------------

* Patrick Hohenecker ([[email protected]](mailto:[email protected]))