Skip to main content

This is just a simple program to test my programing knowledge and to learn more about API and Nautobot.

Project description

Nautobot API Sandbox

This is a simple program to test my programming knowledge and learn more about API, Nautobot, and developing in general.

https://demo.nautobot.com/

Getting Started

  1. Install package: pip install nautobot_api_sandbox

  2. Run package: nautobot_api_sandbox

  3. Enter Demo token: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

    This will start the Nautobot API Sandbox command-line interface. Follow the instructions in the application to interact with the Nautobot API. NOTE: You don't need to add '()' or "" quotes. Simply type the command + the name (e.g., create_tenant tpayne, show_devices atl01).

Development Prerequisites

Before getting started, make sure you have the following installed on your machine:

  • Python 3.9 or later
  • Poetry

Development

  1. Clone the repository: git clone git@github.com:tPayne0647/nautobot-api-sandbox.git
  2. Navigate to the project directory: cd nautobot-api-sandbox
  3. Install the project dependencies using Poetry: poetry install
  4. Install the development dependencies: poetry install --dev
  5. Activate the virtual environment created by Poetry: poetry shell
  6. Run the program: nautobot_api_sandbox

To run the tests: poetry run pytest

Any help or tips would be greatly appreciated!!

Currently Working On / Want to Add

  • Exception handling?
  • Valid unittest? Need more tests...
  • Integrate click? really want to rework UI
  • Make sure using logging correctly
  • Fix delete_tenant RequestError 409
  • Update readme instructions
  • Poetry integration
  • Publish package

This is a work in progress!!!

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

nautobot_api_sandbox-0.1.1.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

nautobot_api_sandbox-0.1.1-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

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