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

Uploaded Source

Built Distribution

feanor-1.2.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: feanor-1.2.0.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.2.0.tar.gz
Algorithm Hash digest
SHA256 ee4ea7b5db9d7d7d963cd73e67022d38ae651365fd39824ce2873bcc45c444e1
MD5 60a64373d81bed049110f5161880876e
BLAKE2b-256 e28f80f3928a281a711b0ce5b81fd466d331e2adf54bce285a8994734d55cd72

See more details on using hashes here.

File details

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

File metadata

  • Download URL: feanor-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 10.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f30b13463188f25033f645a037002bf2284cb949018671c3600cd0ab2311f364
MD5 0109b7eed4c182ab8d7872b10274a6fd
BLAKE2b-256 6a6ac6e7ed7557d9864f98b26d4d75d4f27b62afac54599382384da95270c8b3

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