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.2.4.post1.tar.gz (26.9 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file nusex-1.2.4.post1.tar.gz.

File metadata

  • Download URL: nusex-1.2.4.post1.tar.gz
  • Upload date:
  • Size: 26.9 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.2.4.post1.tar.gz
Algorithm Hash digest
SHA256 23bfc2ac1a24920c99a5fffcd807ac6085aab1fd2af386d8e9dbbe03f47dadd5
MD5 7b6c4cd18e68df40ec1d919beafc15c0
BLAKE2b-256 75692766fba3482eb1cb2e9f684cdb220a2014236fb8e541a0d0d686adcdd3c1

See more details on using hashes here.

File details

Details for the file nusex-1.2.4.post1-py3-none-any.whl.

File metadata

  • Download URL: nusex-1.2.4.post1-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.2.4.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e50a73e349cd1aafb51bdd76419ae08c86eb582b263aad18c190c79a7cbb2a2
MD5 ba28528919ebeda6fff0de3c0d2845db
BLAKE2b-256 f0d7178bb4a12ca429a8b7bbf58876c4e8b7e4a98ecdfb9698ab8965d218a6c4

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