Skip to main content

Awesome `np-lims-tk` is a Python cli/package created with https://github.com/TezRomacH/python-package-template

Project description

np-lims-tk

Build status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit Semantic Versions License Coverage Report

Awesome np-lims-tk is a Python cli/package created with https://github.com/TezRomacH/python-package-template

Development

This section contains additional setup information.

Initializing as a github repo

Initialize your code

  1. Initialize git inside your repo:
cd np-lims-tk && git init
  1. If you don't have Poetry installed run:
make poetry-download
  1. Initialize poetry and install pre-commit hooks:
make install
make pre-commit-install
  1. Run the codestyle:
make codestyle
  1. Upload initial code to GitHub:
git add .
git commit -m ":tada: Initial commit"
git branch -M main
git remote add origin https://github.com/np_lims_tk/np-lims-tk.git
git push -u origin main

Set up bots

  • Set up Dependabot to ensure you have the latest dependencies.
  • Set up Stale bot for automatic issue closing.

Poetry

Want to know more about Poetry? Check its documentation.

Details about Poetry

Poetry's commands are very intuitive and easy to learn, like:

  • poetry add numpy@latest
  • poetry run pytest
  • poetry publish --build

etc

Building and releasing your package

Building a new version of the application contains steps:

  • Bump the version of your package poetry version <version>. You can pass the new version explicitly, or a rule such as major, minor, or patch. For more details, refer to the Semantic Versions standard.
  • Make a commit to GitHub.
  • Create a GitHub release.
  • And... publish 🙂 poetry publish --build

🎯 What's next

Well, that's up to you 💪🏻. I can only recommend the packages and articles that helped me.

  • Typer is great for creating CLI applications.
  • Rich makes it easy to add beautiful formatting in the terminal.
  • Pydantic – data validation and settings management using Python type hinting.
  • Loguru makes logging (stupidly) simple.
  • tqdm – fast, extensible progress bar for Python and CLI.
  • IceCream is a little library for sweet and creamy debugging.
  • orjson – ultra fast JSON parsing library.
  • Returns makes you function's output meaningful, typed, and safe!
  • Hydra is a framework for elegantly configuring complex applications.
  • FastAPI is a type-driven asynchronous web framework.

Articles:

🚀 Features

Development features

Deployment features

Open source community features

Installation

pip install -U np-lims-tk

or install with Poetry

poetry add np-lims-tk

Documentation

https://alleninstitute.github.io/np-lims-tk/

Makefile usage

Makefile contains a lot of functions for faster development.

1. Download and remove Poetry

To download and install Poetry run:

make poetry-download

To uninstall

make poetry-remove

2. Install all dependencies and pre-commit hooks

Install requirements:

make install

Pre-commit hooks coulb be installed after git init via

make pre-commit-install

3. Codestyle

Automatic formatting uses pyupgrade, isort and black.

make codestyle

# or use synonym
make formatting

Codestyle checks only, without rewriting files:

make check-codestyle

Note: check-codestyle uses isort, black and darglint library

Update all dev libraries to the latest version using one comand

make update-dev-deps
4. Code security

make check-safety

This command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.

make check-safety

5. Type checks

Run mypy static type checker

make mypy

6. Tests with coverage badges

Run pytest

make test

7. All linters

Of course there is a command to rule run all linters in one:

make lint

the same as:

make test && make check-codestyle && make mypy && make check-safety

8. Docker

make docker-build

which is equivalent to:

make docker-build VERSION=latest

Remove docker image with

make docker-remove

More information about docker.

9. Cleanup

Delete pycache files

make pycache-remove

Remove package build

make build-remove

Delete .DS_STORE files

make dsstore-remove

Remove .mypycache

make mypycache-remove

Or to remove all above run:

make cleanup

Contributing

Code contributions are greatly appreciated. To contribute, make your changes and potentially add tests to the test suite under /tests to ensure your changes work as expected now and in the future. Then submit your changes in the form of a pull request.

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

List of labels and corresponding titles

Label Title in Releases
enhancement, feature 🚀 Features
bug, refactoring, bugfix, fix 🔧 Fixes & Refactoring
build, ci, testing 📦 Build System & CI/CD
breaking 💥 Breaking Changes
documentation 📝 Documentation
dependencies ⬆️ Dependencies updates

You can update it in release-drafter.yml.

GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

🛡 License

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

np-lims-tk-0.9.2.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

np_lims_tk-0.9.2-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file np-lims-tk-0.9.2.tar.gz.

File metadata

  • Download URL: np-lims-tk-0.9.2.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.9.13 Darwin/20.1.0

File hashes

Hashes for np-lims-tk-0.9.2.tar.gz
Algorithm Hash digest
SHA256 6f0a17ab5e9396e5975e3d482d7eee90b725759081017da285cc11c3ec259ac1
MD5 54fb0d7ced05342f098fa4d522f327dd
BLAKE2b-256 c364a11aed6947069c705f452b71da6865f471201b70c7bc1c323a9568d88eb8

See more details on using hashes here.

File details

Details for the file np_lims_tk-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: np_lims_tk-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.9.13 Darwin/20.1.0

File hashes

Hashes for np_lims_tk-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 38619722f7fb600821bcc59637eff75901c6f3d25057b380ccd734326e9f545a
MD5 7f987dada6c36c272cd6835b6b363e9e
BLAKE2b-256 9f1699377999f879f35839f42bb0b492e3a9aeadbc190f5681f76761c1e55a6f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page