PyMDB-API

The API component for the PyMDB CMDB/DCIM project.

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
• Getting Started
• Usage
• Roadmap
• Contributing

• License
• Contact
• Acknowledgements

🌟 About the Project

📷 Screenshots

👾 Tech Stack

API

• Docker
• Python
• Flask

Database

• MongoDB

🎯 Features

• RESTful API for managing CMDB/DCIM data.
• Token-based authentication for secure access.
• Schema validation for input data integrity.
• Relationship management between different objects.

🧰 Getting Started

For detailed information on setting up a development environment, see the Development Guide.

👀 Usage

For more comprehensive usage documentation, see the docs readme

🧭 Roadmap

• Create an API capable of creating, updating, deleting, and fetching database records.
• Secure the API with token based auth.
• Validate input data based on predetermined schemas.
• Establish links between objects.
• Develop IPAM capabilities.
• Develop more comprehensive support of object types and links.
• Create front end UI.
• Create automation pipelines for executing commands on enrolled servers.
• Implement command execution capabilities to deploy and manage virtual machines on hypervisors using vendor-agnostic methods.

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

⚠️ License

Distributed under the Mozilla Public License 2.0. See LICENSE for more information.

🤝 Contact

Jesse Butryn - linkedin - jesse@jesseb.org

Project Link: https://github.com/Py-MDB/PyMDB-API

💎 Acknowledgements

• Awesome README template