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.0.8.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

feanor-1.0.8-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for feanor-1.0.8.tar.gz
Algorithm Hash digest
SHA256 d8b1432bd5ffd69d61147fe4763bb59a3d5a2880d231e927e4151fc77cda3736
MD5 083a6c68f14b8ab52b46512a723a5480
BLAKE2b-256 5bfc13e0fad2512c39f46f435078466737a3b317e40828b40498fab66c7e7201

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for feanor-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 44ec5ffc78e1f30c54bb2eda2941e13a82438ca5fcd7df6bf9c39dc060e65c91
MD5 62a86feff3c4c09978986d84f1616d5d
BLAKE2b-256 d9a9879342f58be0b2e973bdf62a0438be5cdba6786a9188a061bc2c1cf98303

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