sudoblark-python-core 1.0.0

Core python library for Sudoblark.

sudoblark.python.core

The core Python library for Sudoblark, mainly used to power CLI tooling to augment CI/CD operations.
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Technical Documentation
5. Testing
6. Packaging
7. CI/CD
8. License
9. Contact

About The Project

This is the core Python library for Sudoblark, mainly used to power CLI tooling to augment CI/CD operations.

The live source of documentation may be said to reside here. It is recommended for developers to at least read the "Developers notes" section before attempting to contribute to this repo.

(back to top)

Built With

• Library
  • Python 3.10
• Testing and quality control
  • flake8-pyproject
  • flake8
  • behave!
• Packaging
  • pyproject.toml
• Documentation
  • mkdocstrings-python

(back to top)

Getting Started

The below are instructions for how to develop the core library, for instructions on how to install see the Usage section instead.

Prerequisites

These installation instructions are targeted for MacOS.

• Python3.10

  brew install python@3.10
  

• Poetry

  python3.10 -m venv venv
  source venv/bin/activate
  pip install -U pip setuptools
  pip install poetry
  

Installation

Assume a local virtual environment, and poetry, are setup as per the Prerequisites then installation is simply:

poetry install

Which you may verify via:

python3
import sudoblark_python_core
help(sudoblark_python_core)

(back to top)

Usage

TODO

(back to top)

Technical Documentation

mkdocs is used in order to auto-generation documentation. It is configured via the docs/mkdocs.yml file and - for the most part - doesn't need to be altered. F

In order to generation a local web server of documentation:

mkdocs serve

However, it should be noted that live versioned documentation is produced during the release process by an admin running the mkdocs gh-deploy --force command.

(back to top)

Testing

The Behave! library is utilised in order to conduct end-to-end testing, hopefully proving we can actually interact in a reliable fashion with the GitHub RESTAPI.

For those uninitiated, the basic premise is:

• The features folder is the root of Behave!
• At this top-level, it contains .feature files, which are used to define our test cases
• In the nested steps folder, we will define what the test case components mean in programmatic terms

Checks may be run by simply executing behave locally once the Installation steps have been followed.

NOTE: All scenarios require a valid GITHUB_TOKEN environment variable to be present

(back to top)

Packaging

The package is published to PyPi simply by running the below commands:

poetry build
poetry config pypi-token.pypi <token>
poetry publish

(back to top)

CI/CD

GitHub Actions is used for all CI/CD activities. We give a brief outline of what each pipeline does below.

Pipeline	Triggers	Description
commit-to-pull-request.yaml	Commit on a pull request	Runs flake8 and behavioural tests

(back to top)

License

Distributed under the project_license. See LICENSE.txt for more information.

(back to top)