Metadata-Version: 2.4
Name: nautobot-trax
Version: 0.1.0a0
Summary: Trusted Automation at the Edge - Powered by Nautobot. Tools to enable tactical missions.
License: Apache-2.0
License-File: LICENSE
Keywords: nautobot,nautobot-app,nautobot-plugin
Author: Dwayne Camacho
Author-email: dwayne.a.camacho@gmail.com
Requires-Python: >=3.10,<3.14
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: all
Requires-Dist: mgrs (>=1.5.0)
Requires-Dist: nautobot (>=3.0.0,<4.0.0)
Requires-Dist: nautobot-design-builder (>=3.0.0,<4.0.0)
Requires-Dist: nautobot-golden-config (>=3.0.0,<4.0.0)
Requires-Dist: nautobot-plugin-nornir (>=3.0.0,<4.0.0)
Project-URL: Documentation, https://github.com/d-camacho/nautobot-app-trax/tree/main/docs
Project-URL: Homepage, https://github.com/d-camacho/nautobot-app-trax
Project-URL: Repository, https://github.com/d-camacho/nautobot-app-trax
Description-Content-Type: text/markdown

# Nautobot TRAX

<p align="center">
  <img src="https://github.com/d-camacho/nautobot-app-trax/blob/main/docs/images/trax_full.png" class="logo" height="400px" alt="Nautobot TRAX logo">
  <br>
  <a href="https://github.com/nautobot/nautobot-app-nautobot-trax/actions"><img src="https://github.com/nautobot/nautobot-app-nautobot-trax/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
  <a href="https://docs.nautobot.com/projects/nautobot-trax/en/latest/"><img src="https://readthedocs.org/projects/nautobot-app-nautobot-trax/badge/" alt="Docs"></a>
  <a href="https://pypi.org/project/nautobot-trax/"><img src="https://img.shields.io/pypi/v/nautobot-trax" alt="PyPI version"></a>
  <a href="https://pypi.org/project/nautobot-trax/"><img src="https://img.shields.io/pypi/dm/nautobot-trax" alt="PyPI downloads"></a>
  <br>
  A Nautobot App for tactical mission communications planning, SATCOM transport, and deployable network package execution.
</p>

## Overview

Nautobot TRAX supports tactical mission communications by combining mission planning, SATCOM and Combat Net Radio (CNR) frequency coordination, and transport-path design into a single operational workflow. Teams can model and execute mission packages that span CNR, SATCOM, terrestrial transport, and constrained field-network conditions.

The app links mission plans, transport options, frequency sets, operations, and supporting inventory so planners can coordinate PACE-style communications, map transport dependencies to real devices/circuits/providers, and prepare deployable tactical network packages with traceable data from planning through execution.

## Pre-release Status

Nautobot TRAX is currently in pre-release for early adopters and testing. Interfaces and data models may continue to evolve before a stable 1.0 release.

## Compatibility

- Nautobot: >= 3.0.0, < 4.0.0
- Python: >= 3.10, < 3.14

## Installation

Install from PyPI (including pre-releases):

```shell
pip install --pre nautobot-trax
```

Install a specific pre-release version:

```shell
pip install nautobot-trax==0.1.0a0
```

To keep the app installed during Nautobot upgrades, add it to local requirements:

```shell
echo nautobot-trax >> local_requirements.txt
```

## Enable in Nautobot

Add the app to your Nautobot configuration:

```python
PLUGINS = ["nautobot_trax"]

# Optional plugin settings
# PLUGINS_CONFIG = {
#     "nautobot_trax": {
#         # Add settings here
#     }
# }
```

Run migrations and post-upgrade tasks:

```shell
nautobot-server post_upgrade
```

Restart Nautobot services after installation or upgrade.

## Documentation

- User Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/user/app_overview/
- Administrator Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/admin/install/
- Developer Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/contributing/
- Release Notes: https://docs.nautobot.com/projects/nautobot-trax/en/latest/admin/release_notes/
- FAQ: https://docs.nautobot.com/projects/nautobot-trax/en/latest/user/faq/

## Contributing

Contributions are welcome. For development setup and workflows, see:

- https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/dev_environment/
- https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/contributing/

## Support

For questions, start with the FAQ and then reach out in the Network to Code Slack #nautobot channel:

- http://slack.networktocode.com/

