+-----------+------------------------------------------------------------------------------------+ |General| |maintenance_y| |semver| |license| | +-----------+------------------------------------------------------------------------------------+ |CI | |gha_tests| |gha_docu| |pre_commit_ci| |codestyle| |codecov| | +-----------+------------------------------------------------------------------------------------+ |PyPI | |pypi_release| |pypi_py_versions| |pypi_status| |pypi_format| |pypi_downloads| | +-----------+------------------------------------------------------------------------------------+ |Github | |gh_issues| |gh_language| |gh_last_commit| |gh_deployment| | +-----------+------------------------------------------------------------------------------------+
Designed for the use in the Bright Edge eServices echo system. It defines methods and functions for general use purposes.
.. code-block:: bash
pip install beetools
#. This project uses pytest to run tests.
#. There are various settings combinations in the [tool.pytest.ini_options] section of the pyproject.toml file that can used by commenting it out.
#. 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.
.. code-block:: bash
pytest
Naming Conventions
#. 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.
#. ``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"
#. .rst syntax check
#. git add -A
#. git commit -m message (with `pre-commit` including `black` and `flake8`)
#. git push --all
#. ``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
#. Commit the changes
#. Create and push the release tag with the correct naming conventions.
#. Checkout master since it assumes that the branch is now merged with master and will be deleted.
#. display a list of all the current branches as a reminder to delete the branch on completion.
.. General
.. |maintenance_n| image:: https://img.shields.io/badge/Maintenance%20Intended-✖-red.svg?style=flat-square
:target: http://unmaintained.tech/
:alt: Maintenance - not intended
.. |maintenance_y| image:: https://img.shields.io/badge/Maintenance%20Intended-✔-green.svg?style=flat-square
:target: http://unmaintained.tech/
:alt: Maintenance - intended
.. |license| image:: https://img.shields.io/pypi/l/BEETools
:target: https://github.com/BrightEdgeeServices/beetools/blob/master/LICENSE
:alt: License
.. |semver| image:: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square
:target: https://semver.org/
:alt: Semantic Versioning - 2.0.0
.. |codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style Black
.. CI
.. |pre_commit_ci| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/beetools/pypi-pipeline.yml?label=pre-commit
:target: https://github.com/BrightEdgeeServices/beetools/blob/master/.github/workflows/pre-commit.yml
:alt: Pre-Commit
.. |gha_tests| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/beetools/pypi-pipeline.yml?label=ci
:target: https://github.com/BrightEdgeeServices/beetools/blob/master/.github/workflows/ci.yml
:alt: Test status
.. |gha_docu| image:: https://img.shields.io/readthedocs/beetools
:target: https://github.com/BrightEdgeeServices/beetools/blob/master/.github/workflows/check-rst-documentation.yml
:alt: Read the Docs
.. |codecov| image:: https://img.shields.io/codecov/c/github/BrightEdgeeServices/beetools
:target: https://app.codecov.io/gh/BrightEdgeeServices/beetools
:alt: CodeCov
.. PyPI
.. |pypi_release| image:: https://img.shields.io/pypi/v/beetools
:target: https://pypi.org/project/beetools/
:alt: PyPI - Package latest release
.. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/beetools
:target: https://pypi.org/project/beetools/
:alt: PyPI - Supported Python Versions
.. |pypi_format| image:: https://img.shields.io/pypi/wheel/beetools
:target: https://pypi.org/project/beetools/
:alt: PyPI - Format
.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/beetools
:target: https://pypi.org/project/beetools/
:alt: PyPI - Monthly downloads
.. |pypi_status| image:: https://img.shields.io/pypi/status/beetools
:target: https://pypi.org/project/beetools/
:alt: PyPI - Status
.. GitHub
.. |gh_issues| image:: https://img.shields.io/github/issues-raw/BrightEdgeeServices/beetools
:target: https://github.com/BrightEdgeeServices/beetools/issues
:alt: GitHub - Issue Counter
.. |gh_language| image:: https://img.shields.io/github/languages/top/BrightEdgeeServices/beetools
:target: https://github.com/BrightEdgeeServices/beetools
:alt: GitHub - Top Language
.. |gh_last_commit| image:: https://img.shields.io/github/last-commit/BrightEdgeeServices/beetools/master
:target: https://github.com/BrightEdgeeServices/beetools/commit/master
:alt: GitHub - Last Commit
.. |gh_deployment| image:: https://img.shields.io/github/deployments/BrightEdgeeServices/beetools/pypi
:target: https://github.com/BrightEdgeeServices/beetools/deployments/pypi
:alt: GitHub - PiPy Deployment
FAQs
Tools for batch scripts, virtual environments and utilities.
We found that beetools demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.