couchdb-openapi-scheme-generator 1.0.2

CouchDB OpenAPI scheme generator

🚀 CouchDB OpenAPI Scheme Generator

OpenAPI specification generator for CouchDB - Perfect for developing and debugging applications using CouchDB as a backend

---

📋 Table of Contents

• 🚀 CouchDB OpenAPI Scheme Generator
  • 📋 Table of Contents
  • ✨ Features
  • 🎯 Description
  • 📦 Requirements
  • 🚀 Quick Start
  • 💻 Installation
    • Step 1: Clone the repository
    • Step 2: Install dependencies
  • 📖 Usage
    • 🐳 Starting CouchDB
    • 📄 Generating OpenAPI Specification
      • Basic Usage
      • Advanced Usage
      • 📋 Parameters
    • 🎮 Running the Main Application
  • 🏗️ Project Structure
  • 🛠️ Development
    • Setting Up Development Environment
    • Code Style
  • 🤝 Contributing
    • Contribution Guidelines
  • 📝 License
  • ⭐ Show Your Support
    • Made with ❤️ by SasukeSagara
      • ⭐ Star this repo if you find it useful! ⭐

---

✨ Features

Feature	Description	Status
🐳 Docker Support	Quick CouchDB deployment with Docker Compose	✅ Ready
📄 OpenAPI 3.0	Modern OpenAPI specification generator	✅ Ready
🔧 CLI Tool	Easy-to-use command-line interface	✅ Ready
📊 JSON/YAML	Support for both JSON and YAML output formats	✅ Ready
🔐 Authentication	Built-in support for CouchDB authentication	✅ Ready
⚡ Fast Setup	Get started in minutes	✅ Ready

---

🎯 Description

This project has been updated for more convenient work with CouchDB and includes:

• 🐳 Updated Docker Compose configuration for quick CouchDB deployment
• 📄 Modern OpenAPI specification generator for CouchDB API
• 🛠️ Utilities and tools for interacting with the CouchDB server
• 🚀 Production-ready setup with best practices

---

📦 Requirements

• 🐍 Python 3.11 or higher
• 🐳 Docker and Docker Compose
• 📦 uv (Python package manager)

---

🚀 Quick Start

# 1. Clone the repository
git clone https://github.com/SasukeSagara/CouchDB-OpenAPI-scheme-generator.git
cd couchdb-openapi-scheme-generator

# 2. Install dependencies
uv sync

# 3. Start CouchDB
docker-compose up -d

# 4. Generate OpenAPI specification
uv run openapi_generator.py

That's it! 🎉 Your OpenAPI specification will be generated in couchdb-openapi.json

---

💻 Installation

Step 1: Clone the repository

git clone https://github.com/SasukeSagara/CouchDB-OpenAPI-scheme-generator.git
cd couchdb-openapi-scheme-generator

Step 2: Install dependencies

Install dependencies using uv:

uv sync

For development dependencies:

uv sync --dev

---

📖 Usage

🐳 Starting CouchDB

Start CouchDB using Docker Compose:

docker-compose up -d

CouchDB will be available at http://localhost:5984

⚠️ Important: Change the password in .env before using in production!

📄 Generating OpenAPI Specification

Use openapi_generator.py to generate the OpenAPI specification for CouchDB API:

Basic Usage

# Basic usage (local server)
uv run openapi_generator.py

Advanced Usage

# With URL and credentials specified
uv run openapi_generator.py \
  --url http://localhost:5984 \
  --username admin \
  --password your_password

# With custom output file
uv run openapi_generator.py --output couchdb-api.json

# Generate in YAML format
uv run openapi_generator.py \
  --format yaml \
  --output couchdb-api.yaml

# Full example with all options
uv run openapi_generator.py \
  --url http://localhost:5984 \
  --username admin \
  --password your_password \
  --format json \
  --output my-couchdb-api.json

📋 Parameters

Parameter	Short	Description	Default
--url	-u	CouchDB server URL	http://localhost:5984
--username	-	Username for authentication	-
--password	-	Password for authentication	-
--output	-o	Output file name	couchdb-openapi.json
--format	-f	Output format (json or yaml)	json

🎮 Running the Main Application

uv run genopenapi_generatorerator.py

---

🏗️ Project Structure

CouchDB-OpenAPI-scheme-generator/
├── 📁 couchdb-data/          # CouchDB data (Docker volume)
├── 📁 couchdb-etc/           # CouchDB configuration
├── 📄 docker-compose.yml     # Docker Compose configuration
├── 📄 main.py                # Main application file
├── 📄 openapi_generator.py   # OpenAPI specification generator
├── 📄 pyproject.toml         # Python project configuration
├── 📄 uv.lock                # Dependency lock file
├── 📄 .env                   # Environment variables (create this)
├── 📄 .gitignore             # Git ignore rules
├── 📄 LICENSE                # MIT License
└── 📄 README.md              # This file

---

🛠️ Development

Setting Up Development Environment

1. Clone the repository:

   git clone https://github.com/SasukeSagara/CouchDB-OpenAPI-scheme-generator.git
   cd couchdb-openapi-scheme-generator
   

2. Install development dependencies:

   uv sync --dev
   

3. Create .env file:

   cp .env.example .env  # If you have an example file
   # Or create manually with:
   # COUCHDB_USER=admin
   # COUCHDB_PASSWORD=your_secure_password
   

4. Start CouchDB:

   docker-compose up -d
   

5. Run tests (if available):

   uv run pytest
   

Code Style

This project follows PEP 8 style guidelines. Consider using:

• black for code formatting
• flake8 or ruff for linting
• mypy for type checking

---

🤝 Contributing

Contributions are welcome! 🎉

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contribution Guidelines

• 📝 Follow the existing code style
• ✅ Add tests for new features
• 📖 Update documentation as needed
• 🐛 Report bugs using GitHub Issues
• 💡 Suggest enhancements using GitHub Discussions

---

📝 License

This project is distributed under the MIT License. See the LICENSE file for details.

---

⭐ Show Your Support

If you find this project helpful, please consider:

• ⭐ Starring this repository
• 🍴 Forking this repository
• 🐛 Reporting bugs
• 💡 Suggesting new features
• 📖 Improving documentation
• 🤝 Contributing code

---

Made with ❤️ by SasukeSagara

⭐ Star this repo if you find it useful! ⭐