Skip to main content

A dynamic, multi-language project templating utility.

Project description

nusex

PyPi version PyPI - Status Downloads GitHub last commit License

CI Read the Docs Maintainability Test Coverage

A dynamic, multi-language project templating utility.

CPython versions 3.6 through 3.11-dev and PyPy versions 3.6 through 3.8 are officially supported.

Windows, MacOS, and Linux are all supported.

Features

  • An easy-to-use CLI (command-line interface)
  • Dynamic templating using placeholder variables
  • Template add-ons for use during the whole development lifecycle
  • A profile system for those who maintain personal and organisation-owned projects
  • Automatic dependency installation
  • Premade templates for applications and packages
  • 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/nusex/nusex

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:

nusex 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
nusex deploy nsx_simple_app

# For PyPI packages
nusex deploy nsx_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-1.3.0.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

nusex-1.3.0-py3-none-any.whl (58.3 kB view details)

Uploaded Python 3

File details

Details for the file nusex-1.3.0.tar.gz.

File metadata

  • Download URL: nusex-1.3.0.tar.gz
  • Upload date:
  • Size: 27.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for nusex-1.3.0.tar.gz
Algorithm Hash digest
SHA256 90ab2ce297e634b564583804190c7e7745faf9df568ac8d3ccf33cca5ef48f12
MD5 d4da5734106c0021af3457e48166a129
BLAKE2b-256 42cbb0983d9a9501ee74c9f254639726913023609960863b0cdfa418b2b7eb66

See more details on using hashes here.

File details

Details for the file nusex-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: nusex-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 58.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for nusex-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f6d6d837458492a3d2fd7de07e435ea264dc20ded1486e89e8c09c2945dad0e
MD5 32eb31cc856aa5747de5d14b69194287
BLAKE2b-256 4d61df442fe8ff1783b46aaed4d41ae537953b2943b0732ca3a020e1b769c130

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