Skip to main content

Build secure Django backends and modular Frappe business systems.

Project description

NOXUS CORE

NOXUS CORE generates secure standalone Django website backends and assembles modular, self-hosted Frappe business systems. ERPNext is optional and remains unmodified.

pip install noxusai
noxusai doctor
noxusai new

Install the CLI in a dedicated virtual environment or with pipx; do not install it into the same Python environment as Frappe Bench. Bench 5.31.0 constrains a vulnerable Click 8.2 line, while NOXUS locks the remediated Click 8.3.3 release. The generated Frappe runtime remains isolated in containers.

The project is currently preparing the 1.0.0rc1 release candidate. No package has been published; install from a locally built wheel while developing.

Who it is for

  • Developers who need a professional content and contact API for a company website.
  • Teams building modular CRM, inventory, projects, support, maintenance, transport, or education systems on Frappe.
  • Community module authors who need a validated manifest, dependency resolver, permissions, workflows, reports, and repeatable Docker environment.

Architecture

The Python distribution contains the Typer/Rich CLI, strict Pydantic schemas, safe Jinja templates, NOXUS Frappe app sources, compiled React UI, and checksummed deployment resources. Generated website projects are independent Django/DRF applications. SaaS projects run one isolated Frappe site and database per tenant. See the architecture and threat model.

Prerequisites

  • Python 3.11–3.14 for the CLI; Frappe container images use Python 3.14.
  • Git for source development and --edge only.
  • Docker Engine and Docker Compose for SaaS and Docker website workflows.
  • Node.js 24.18.0 for monorepo UI development; normal wheel users receive compiled assets.

Run noxusai doctor --workflow website or noxusai doctor --workflow saas for real checks.

Local development

Linux and macOS:

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
noxusai --version

Windows PowerShell:

py -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install -e ".[dev]"
noxusai --version

Install frontend dependencies with npm install. Run make check test on Unix or the equivalent commands from the Makefile in PowerShell.

Website generator

noxusai new website \
  --name acme-website \
  --database postgres \
  --auth both \
  --modules company,website,services,portfolio,team,contact,seo,media \
  --docker --yes

The generated README contains exact Docker and virtual-environment commands, migrations, seed data, superuser creation, tests, health endpoints, and OpenAPI URLs.

SaaS generator

noxusai new saas \
  --name acme-operations \
  --industry maintenance \
  --modules crm,inventory,maintenance \
  --with-erpnext --docker --yes

Stable creation extracts the versioned runtime bundled in the wheel. Development from an external branch is explicit: --edge --repository-url <url>. The Community Deploy experience applies a blueprint to the current site or produces local Docker/self-hosting instructions; it does not pretend to provision cloud resources.

Module development

noxusai module create repairs
noxusai module validate noxus_repairs
noxusai module list

Module manifests are schema-versioned and dependency installation is deterministic. ERPNext features are adapters over an optional ERPNext installation, never core patches.

Testing and deployment

  • make check runs Python and frontend lint/type checks.
  • make test runs fast Python and frontend tests.
  • make test-integration runs service-dependent tests.
  • make test-e2e runs Playwright.
  • make release-check-local rebuilds the UI and release manifest, then validates every non-container release gate.
  • make release-check additionally runs the destructive disposable container acceptance suites and remains mandatory before publication.

Deployment, backup, recovery, security, workflows, permissions, and troubleshooting documentation lives under docs/. CI and release automation create artifacts but public publication remains behind an explicit protected approval. Maintainers should follow the release and PyPI runbook.

Security, licensing, and contributing

Read SECURITY.md before reporting vulnerabilities and CONTRIBUTING.md before submitting changes. Original NOXUS code and generated templates use GPL-3.0-or-later. Dependency licenses remain their own; licensing guidance is not legal advice.

The immediate roadmap is tracked with evidence in PLANS.md and changes in CHANGELOG.md.

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

noxusai-1.0.0rc1.tar.gz (229.2 kB view details)

Uploaded Source

Built Distribution

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

noxusai-1.0.0rc1-py3-none-any.whl (330.7 kB view details)

Uploaded Python 3

File details

Details for the file noxusai-1.0.0rc1.tar.gz.

File metadata

  • Download URL: noxusai-1.0.0rc1.tar.gz
  • Upload date:
  • Size: 229.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for noxusai-1.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 ec16dde7d5135b6e7679bbd8bfe0fca48420875243a26da390aba98cf5ddcc46
MD5 d37c8f08c0c3d6b6e248eb8977ee61fd
BLAKE2b-256 765da81058bd4dcf01babf4827729d33e0fdf1c96d1f462db62f321c4067c2e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for noxusai-1.0.0rc1.tar.gz:

Publisher: release.yml on 5bv57zcm44-max/noxus-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file noxusai-1.0.0rc1-py3-none-any.whl.

File metadata

  • Download URL: noxusai-1.0.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 330.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for noxusai-1.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 2814839560c8b1f0aa3c56df1b4f922cfbe061667bfaa117868fdf8be71785b8
MD5 b211dd4c2e7466f201c9870ec23fca2b
BLAKE2b-256 e5d138b3df510b671fe987b935d16545672d7174493b6351d9758743a0985383

See more details on using hashes here.

Provenance

The following attestation bundles were made for noxusai-1.0.0rc1-py3-none-any.whl:

Publisher: release.yml on 5bv57zcm44-max/noxus-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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