Skip to main content

Tools for batch scripts, virtual environments and utilities.

Project description

General

Maintenance - intended Semantic Versioning - 2.0.0 License

CI

Test status Read the Docs Pre-Commit Code Style Black CodeCov

PyPI

PyPI - Package latest release PyPI - Supported Python Versions PyPI - Status PyPI - Format PyPI - Monthly downloads

Github

GitHub - Issue Counter GitHub - Top Language GitHub - Last Commit GitHub - PiPy Deployment

Designed for the use in the Bright Edge eServices echo system. It defines methods and functions for general use purposes.

Installation

pip install beetools

Tests

  1. This project uses pytest to run tests.

  2. There are various settings combinations in the [tool.pytest.ini_options] section of the pyproject.toml file that can used by commenting it out.

  3. This project uses black to format code and flake8 for linting. We also support pre-commit to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.

pytest

Contributing

Naming Conventions

  1. Branch names

    “enhancement” | “bug” | “hotfix”/< ticket_nr>_<description>

    where

    enhancement - Planned improvement or addition to functionality; non-urgent.

    bug - An error or defect causing incorrect or unexpected behavior; typically fixed in regular development cycles.

    hotfix - An urgent, critical fix applied directly to the live environment, often bypassing regular development cycles.

    ticket_nr: Ticket number assigned to the issue in GitHub. Once an issue is registered, the owner will assign a ticket.

    description: GitHub issue title or combination of titles is more than one issue is addressed.

Releasing

For the purpose of push and release of code two script files are included. Use there two files to files to make life a bit easier. The scripts make use of the gitit module to simplify tasks.

  1. push.bat - Use this script to push branches to GitHub repository. In principle it does the following:

    usage: push message

    e.g. push “Changed the Infinite Improbability Drive”

    1. .rst syntax check

    2. git add -A

    3. git commit -m message (with pre-commit including black and flake8)

    4. git push –all

  2. release.bat - Use this script to push a new tag and release to the GitHub repository. Remember to change the version number in the setup.cfg else the workflow will fail.

    usage: release version The version will match the release and the tag. Only issue a release once a push.bat was successful. In principle it does the following:

    e.g. release 1.2.3

    1. Commit the changes

    2. Create and push the release tag with the correct naming conventions.

    3. Checkout master since it assumes that the branch is now merged with master and will be deleted.

    4. display a list of all the current branches as a reminder to delete the branch on completion.

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

beetools-5.1.1.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

beetools-5.1.1-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file beetools-5.1.1.tar.gz.

File metadata

  • Download URL: beetools-5.1.1.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for beetools-5.1.1.tar.gz
Algorithm Hash digest
SHA256 ae11ca80ef1c8e0f3e7c2e3631150129502e1ef2345514cc1d4d4f09247f4ae0
MD5 379bcdf3ae7b0b7dfcf3f74bf6992831
BLAKE2b-256 73730fc4b95e289d6f4d9cdba02bae1a26318514ea7a1ed70344494e15afb38a

See more details on using hashes here.

File details

Details for the file beetools-5.1.1-py3-none-any.whl.

File metadata

  • Download URL: beetools-5.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for beetools-5.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 644d30cd57a500067adad6dd8e5e6f272e942c7c1c9a1d06fc474aac3fc8069c
MD5 599648fefbe52381c9d9810f2114d571
BLAKE2b-256 2eb156c809245c8cb58cb709c86f23741adbd57114efd6417d187dcd57d881a9

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