Skip to main content

A project templating utility for Python.

Project description

nusex

PyPi version PyPI pyversions PyPI - Implementation PyPI - Status PyPI - Downloads

Maintenance GitHub Release Date GitHub last commit Read the Docs License

A project templating utility for Python.

Features

  • An easy-to-use CLI (command-line interface)
  • Premade templates for applications and packages
  • The ability to use context clues to dynamically generate files
  • Options to ignore file extensions and directories when building templates
  • No dependencies!

Installation

You need Python 3.6.0 or greater to run nusex.

To install the latest stable version of nusex, use the following command:

pip install nusex

You can also install the latest development version using the following command:

pip install git+https://github.com/parafoxia/nusex.git@develop

You may need to prefix these commands with a call to the Python interpreter depending on your OS and Python configuration.

Quickstart

Before you can build and deploy templates with nusex, you need to initialise it. You only need to do this once, and not for every new project. To initialise nusex, use the following command:

nsx init

Some premade templates will be downloaded for you to experiment with. You can deploy these templates with the following command(s):

# For general applications
nsx deploy simple_app

# For PyPI packages
nsx deploy simple_pkg

To learn how to build templates of your own, read the documentation.

Contributing

nusex is open to contributions. To find out where to get started, have a look at the contributing guide.

License

The nusex module for Python is licensed under the BSD 3-Clause License.

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

nusex-0.4.0.dev2.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

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

nusex-0.4.0.dev2-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file nusex-0.4.0.dev2.tar.gz.

File metadata

  • Download URL: nusex-0.4.0.dev2.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for nusex-0.4.0.dev2.tar.gz
Algorithm Hash digest
SHA256 804758378ab4c4f41bae7546814f24299bb48e5b9b562c1ee7297536a3186f1d
MD5 6f79ce3efb03400ddbb1c6f5ce05cd64
BLAKE2b-256 1a4b507643f4505cbb62e9ca35cc1de754a88f820436a7a6f77afda79ee1227e

See more details on using hashes here.

File details

Details for the file nusex-0.4.0.dev2-py3-none-any.whl.

File metadata

  • Download URL: nusex-0.4.0.dev2-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for nusex-0.4.0.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 41384f0e34fba947e37a3f0813fa5be3ad65776e56f2dfb3efaa0d7df86f459e
MD5 3a869fbfbc3234e805b5f7f2be25d0f6
BLAKE2b-256 cd764c488a9238ac63c944ccda53df2def37424367c0fb878765247c67e561f4

See more details on using hashes here.

Supported by

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