Skip to content

Latest commit

 

History

History
87 lines (70 loc) · 3.51 KB

README.md

File metadata and controls

87 lines (70 loc) · 3.51 KB
Raw

The e3 Project

Build Status Checked with mypy Documentation Status codecov Code style: black CII Best Practices

This present project (e3) is a Python framework to ease the development of portable automated build systems (compilation, dependencies management, binary code packaging, and automated testing).

The e3 framework is split across multiple Python packages named e3-<name> and sharing the same namespace: e3.

e3-core content

e3-core package is organized in several packages and modules:

  • anod: build system handling dependencies management and binary code packaging. This includes a driver that can parse .anod specification files.
  • archive: support for reading and writing tar and zip archives
  • collection: generic collections, e.g. an implementation of Direct Acyclic Graphs
  • cve: small interface to NVD API to query CVE impacting a CPE
  • decorator: Python decorators, e.g. a memoize decorator
  • diff: functions to compute a diff or apply it
  • electrolyt: support for parsing build plans
  • env: global environment handling
  • error: e3 exceptions
  • event: interface for notifying external services
  • fingerprint: support for creating a synthetic view of set of conditions and determining whether those conditions have changed or not.
  • fs: high-level file system operations, using globbing, walk,...
  • hash: computation of sha1, md5
  • log: logging helpers
  • main: main program initialization, command line parsing,...
  • mainloop: generic loop for running jobs
  • net: network utilities
    • net.http: helper for sending http requests and downloading files
    • net.smtp: helper for sending emails through smtp
  • os: platform independent interface to Operating System functions
    • os.fs: low-level file system operations, no logging involved
    • os.platform: tools to detect the platform
    • os.process: interface to run process, to control the execution time,...
    • os.timezone: platform independent interface to get the machine timezone
  • platform: generic interface for providing platform information
  • platform_db: knowledge base for computing platform information
  • spdx: simple interface for generating SPDX files
  • store: interface to download and store resources in a store
  • sys: e3 information, sanity check, ...
  • text: text formatting and transformation
  • vcs: high level interface to VCS repositories
  • yaml: helpers for parsing yaml data

See e3-core documentation for more details.

Install

requires: Python >=3.9

e3-core releases are available on PyPI and can be installed by running:

pip install e3-core

To install from the source package, run:

python setup.py install

All e3 dependencies will also be installed.

Contributing

See CONTRIBUTING.md.