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

Uploaded Source

Built Distribution

feanor-1.1.4-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for feanor-1.1.4.tar.gz
Algorithm Hash digest
SHA256 c14f713f5814c757babe8e3d4ab57afc35f886032576b0a6b9f084fe43f86e42
MD5 7921b4555b1153c97714c5ed8f59847b
BLAKE2b-256 c0614eaf648c7e67d144f140a214eb3fab220697ae24647362948c758bcea099

See more details on using hashes here.

File details

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

File metadata

  • Download URL: feanor-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.1 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.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 961e29a05e5c48fbe6dd02165c7ddb2573da4066ce9fa44a03485ab746d72b05
MD5 d624a64e1dc8f8c7fda2eb5a6bcbec19
BLAKE2b-256 a82d370da24a97b8f6c8e628320244aa61b9bf5bccc75b93fa6914fba8b849c7

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