Skip to main content

# Palgen

[![PyPI](https://img.shields.io/pypi/v/palgen.svg)](https://pypi.org/project/palgen/) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/your_username/palgen/blob/main/LICENSE) [![Documentation](https://img.shields.io/badge/Documentation-palgen.palliate.io-brightgreen)](https://palgen.palliate.io)

Palgen is a powerful and modular command line tool aiming to simplify writing various common utilities such as build scripts, code generators and preprocessors. Palgen provides an easy-to-use interface for creating command line applications by automatically generating command line interfaces (CLIs) from pydantic schemas. This allows for file-based configurations and setting validation.

## Features

  • Easily extendible. Once your user provided class inherits from palgen’s Extension interface it will be recoginized as extension and become runnable.

  • Automatic generation of command line interfaces.

  • Settings validation using pydantic.

  • Easy migration from existing Python projects.

  • Easy-to-use ingest pipelines for processing data.

  • Automatic parallelization of extension pipelines unless disabled.

  • Comprehensive documentation available at [palgen.palliate.io](https://palgen.palliate.io).

## Installation

Palgen can be installed via pip:

`shell pip install git+https://github.com/palliate/palgen.git@master `

For now it is necessary to pull it from git directly. A proper release will soon follow.

## Documentation

The detailed documentation for palgen can be found at [palgen.palliate.io](https://palgen.palliate.io). It includes guides, examples, and API reference documentation to help you get started and make the most out of palgen.

## Examples

Check out the [examples](https://github.com/palliate/palgen/tree/master/examples) subfolder in the repository for various usage examples for palgen.

Palgen itself uses palgen to generate parts of its documentation. You can check out those more complex extensions in the [docs/modules](https://github.com/palliate/palgen/tree/master/docs/modules) subfolder. Since this project is part of the [palliate](https://palliate.io) project you may find additional usage examples in the other repositories within the [palliate organization](https://github.com/palliate).

## Contributing

Contributions to palgen are very welcome! If you find any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/palliate/palgen). You can also submit pull requests with bug fixes or new features.

Before making a contribution, please ensure that you have read and understood the [Contributing Guidelines](https://github.com/palliate/palgen/blob/main/CONTRIBUTING.md).

## Community and Support

Join the palliate Discord server to connect with the community and get support for palgen and other palliate projects. [Join here](https://discord.palliate.io).

## License

Palgen is licensed under the MIT License. See the [LICENSE](https://github.com/palliate/palgen/blob/master/LICENSE) file for more details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

palgen-0.1.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

palgen-0.1-py3-none-any.whl (44.7 kB view details)

Uploaded Python 3

File details

Details for the file palgen-0.1.tar.gz.

File metadata

  • Download URL: palgen-0.1.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for palgen-0.1.tar.gz
Algorithm Hash digest
SHA256 987997bca84726ffd573d5955707989a3ec20a97ad05d20f0191556eb8bb28e1
MD5 851ba3ce18bb03c35c9aba3cdb8fd341
BLAKE2b-256 5df1dd82170a470f400b2d84f22b6b70353225965000939a9ce0fad398b83f65

See more details on using hashes here.

File details

Details for the file palgen-0.1-py3-none-any.whl.

File metadata

  • Download URL: palgen-0.1-py3-none-any.whl
  • Upload date:
  • Size: 44.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for palgen-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 516ec1cdd0db01370e8cf7442e73362b8e5166b567473401236630dc960a05c4
MD5 9d5a8bd0a7c0213114e623409b520c22
BLAKE2b-256 1ab8a1163c579b479b79d1054d23f5a05899a6b3031cc598faa6dfb89b4495b8

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page