Code Monkey home page Code Monkey logo

nautobot-api-sandbox's Introduction

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: sudo 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 + name (e.g., create_tenant tpayne, show_devices atl01).

    To update: pip install --upgrade nautobot_api_sandbox

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 [email protected]: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: python -m nautobot_api_sandbox.nautobot_api_sandbox_ui

To run the tests: poetry run pytest

Currently Working On / Want to Add

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

This is a work in progress!!!

nautobot-api-sandbox's People

Contributors

tpayne0647 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.