{"id":30668115,"url":"https://github.com/datumbrain/alembic-starter","last_synced_at":"2025-08-31T23:09:21.413Z","repository":{"id":312563998,"uuid":"995957736","full_name":"datumbrain/alembic-starter","owner":"datumbrain","description":"Alembic starter project with PostgreSQL.","archived":false,"fork":false,"pushed_at":"2025-06-04T08:56:23.000Z","size":15,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-31T16:04:11.138Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datumbrain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-04T08:49:59.000Z","updated_at":"2025-06-04T08:56:25.000Z","dependencies_parsed_at":"2025-08-31T16:04:15.202Z","dependency_job_id":"a5b447af-1a42-4108-8cec-ee78e437148b","html_url":"https://github.com/datumbrain/alembic-starter","commit_stats":null,"previous_names":["datumbrain/alembic-starter"],"tags_count":null,"template":true,"template_full_name":null,"purl":"pkg:github/datumbrain/alembic-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datumbrain%2Falembic-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datumbrain%2Falembic-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datumbrain%2Falembic-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datumbrain%2Falembic-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datumbrain","download_url":"https://codeload.github.com/datumbrain/alembic-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datumbrain%2Falembic-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273051827,"owners_count":25037077,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-31T23:09:20.850Z","updated_at":"2025-08-31T23:09:21.404Z","avatar_url":"https://github.com/datumbrain.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Alembic SQLAlchemy PostgreSQL Starter\n\nA complete starter project for Python applications using Alembic for database migrations, SQLAlchemy for ORM, and PostgreSQL as the database.\n\n## Project Structure\n\n```raw\nalembic-starter/\n├── main.py\n├── requirements.txt\n├── .env.example\n├── .gitignore\n├── alembic.ini\n├── alembic/\n│   ├── __init__.py\n│   ├── env.py\n│   ├── script.py.mako\n│   └── versions/\n│       └── __init__.py\n├── models/\n│   ├── __init__.py\n│   ├── base.py\n│   └── user.py\n├── database/\n│   ├── __init__.py\n│   └── connection.py\n└── README.md\n```\n\n- `main.py` - Main application entry point\n- `database/connection.py` - Database configuration and session management\n- `models/` - SQLAlchemy models\n- `alembic/` - Migration files and configuration\n- `requirements.txt` - Python dependencies\n- `.env` - Environment variables (create from .env.example)\n\n## Features\n\n- ✅ Alembic for database migrations\n- ✅ SQLAlchemy 2.0 with modern syntax\n- ✅ PostgreSQL integration\n- ✅ Environment-based configuration\n- ✅ Base model with common fields\n- ✅ Sample User model\n- ✅ Proper project structure\n\n## Quick Start\n\n### 1. Setup Environment\n\n```bash\n# Clone or create project directory\ncd alembic-starter\n\n# Create virtual environment\npipenv shell\npipenv install\n```\n\n### 2. Configure Database\n\n```bash\n# Copy environment template\ncp .env.example .env\n```\n\n### 3. Initialize Alembic (if starting fresh)\n\nThis creates the alembic folder structure\n\n```bash\nalembic init alembic\n```\n\n### 4. Create Initial Migration\n\n```bash\n# Generate initial migration from models\nalembic revision --autogenerate -m \"Initial migration\"\n\n# Apply migrations\nalembic upgrade head\n```\n\n### 5. Test the Setup\n\n```bash\n# Run the main script to test everything\npython main.py\n```\n\n## Common Commands\n\n```bash\n# Create new migration\nalembic revision --autogenerate -m \"Description of changes\"\n\n# Apply migrations\nalembic upgrade head\n\n# Rollback migration\nalembic downgrade -1\n\n# Show migration history\nalembic history\n\n# Show current revision\nalembic current\n```\n\n## Adding New Models\n\n1. Create model file in `models/` directory\n2. Import the model in `alembic/env.py`\n3. Generate migration: `alembic revision --autogenerate -m \"Add new model\"`\n4. Apply migration: `alembic upgrade head`\n\n## Environment Variables\n\n- `DATABASE_URL` - Complete PostgreSQL connection string\n- `POSTGRES_USER` - Database username\n- `POSTGRES_PASSWORD` - Database password\n- `POSTGRES_HOST` - Database host (default: localhost)\n- `POSTGRES_PORT` - Database port (default: 5432)\n- `POSTGRES_DB` - Database name\n\n## Tips\n\n- Always review generated migrations before applying them\n- Use descriptive names for your migrations\n- Test migrations on a copy of production data\n- Keep your models in sync with your database schema\n- Use `alembic history` to track migration changes\n\n## Setup Instructions\n\n1. **Create the project directory and files** using the structure above\n2. **Set up virtual environment:**\n\n   ```bash\n   python -m venv venv\n   source venv/bin/activate  # Linux/Mac\n   # or\n   venv\\Scripts\\activate  # Windows\n   ```\n\n3. **Install dependencies:**\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. **Configure environment:**\n\n   ```bash\n   cp .env.example .env\n   # Edit .env with your PostgreSQL credentials\n   ```\n\n5. **Create initial migration:**\n\n   ```bash\n   alembic revision --autogenerate -m \"Initial migration\"\n   alembic upgrade head\n   ```\n\n6. **Test the setup:**\n\n   ```bash\n   python main.py\n   ```\n\nThis starter provides a solid foundation with proper separation of concerns,\nenvironment configuration, and follows SQLAlchemy 2.0 best practices.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatumbrain%2Falembic-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatumbrain%2Falembic-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatumbrain%2Falembic-starter/lists"}