Skip to main content

Python script for simplify automatic build, tests, publish and deploy of projects.

Project description

Fëanor

Description

Python script for simplify automatic build, tests, publish and deploy of projects.

  • only one file to create
  • based on python classes
  • easy to use
  • compatible with any language
  • usable in CI/CD pipelines
  • clear logs for debugging
  • build from a temporary directory, so the source code is not modified
  • fully support python virtual environments, useful for python projects
  • can process custom arguments, for set up a conditional build for example
  • choose the files you want to export from the build

Usage

create a file named pack.py in the root of your project with the following content:

from feanor import BaseBuilder

class Builder(BaseBuilder):
    def Setup(self):
        pass

    def Tests(self):
        pass

    def Docs(self):
        pass
        
    def Build(self):
        pass

    def BuildTests(self):
        pass

    def Publish(self):
        pass
        

You can rename the Builder class to any name you want.

You can rename the file to any name you want.

Remove the methods that you don't need (Setup and Build are the only required methods).

run the script with:

python pack.py

Options

use python pack.py --help to see the available options:

-h, --help            show this help message and exit
  --debug               Enable debug messages
  --deep-debug          Enable deep debug messages
  --version, -v         show program's version number and exit

Builder options:
  --no-tests            Do not run tests
  --no-docs             Do not generate documentation
  --publish             Publish the package
  --no-clean            Do not clean temporary files
  --dist-dir DIST_DIR   Distribution directory (where to save the built files)
  -pv PACKAGE_VERSION, --package-version PACKAGE_VERSION
                        set the version of the package you want to build

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

feanor-1.2.2.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

feanor-1.2.2-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file feanor-1.2.2.tar.gz.

File metadata

  • Download URL: feanor-1.2.2.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for feanor-1.2.2.tar.gz
Algorithm Hash digest
SHA256 02e0005da2892d5e3351c21b9d64e54e54cb5fcdea2c4bdb6482b739a685324f
MD5 5b1e69f7834f8dceb26d085287696e5b
BLAKE2b-256 90ca1098a8b9e9fb5fd57cae19bb5b88de3d834b303740692a69d313611c800b

See more details on using hashes here.

File details

Details for the file feanor-1.2.2-py3-none-any.whl.

File metadata

  • Download URL: feanor-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for feanor-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 88312fc57849633dfbcf1d9764c7d18eba31f190c1ad3a1c2e2e51f67756ba05
MD5 4b7ec6d91d3a92b080d60b8849597f8b
BLAKE2b-256 31095347bd881e6b1bf09c67bbea665d2982a7b9061057773966abfc79027088

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