{"id":21837080,"url":"https://github.com/mshaaban0/pixi-docker-template","last_synced_at":"2025-10-08T07:30:56.280Z","repository":{"id":252457529,"uuid":"840502376","full_name":"mshaaban0/pixi-docker-template","owner":"mshaaban0","description":"A Python project boilerplate template for new projects with Pixi, Flask, Jupyter Notebook and Docker Compose. ","archived":false,"fork":false,"pushed_at":"2024-08-12T12:41:56.000Z","size":39,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-27T20:44:07.044Z","etag":null,"topics":["docker","jupyter-notebook","pixi","python","qdrant"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mshaaban0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-08-09T21:25:01.000Z","updated_at":"2024-08-18T13:29:00.000Z","dependencies_parsed_at":"2024-08-09T22:54:21.257Z","dependency_job_id":null,"html_url":"https://github.com/mshaaban0/pixi-docker-template","commit_stats":null,"previous_names":["mshaaban0/pixi-docker-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mshaaban0%2Fpixi-docker-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mshaaban0%2Fpixi-docker-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mshaaban0%2Fpixi-docker-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mshaaban0%2Fpixi-docker-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mshaaban0","download_url":"https://codeload.github.com/mshaaban0/pixi-docker-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235689558,"owners_count":19030080,"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","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":["docker","jupyter-notebook","pixi","python","qdrant"],"created_at":"2024-11-27T20:44:08.371Z","updated_at":"2025-10-08T07:30:55.924Z","avatar_url":"https://github.com/mshaaban0.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Project Boilerplate with Pixi, Flask, Jupyter Notebook, and Docker Compose\n\nThis repository provides a boilerplate for new Python projects using Pixi for dependency management and Docker Compose for containerization. It includes a basic Flask application connected to a Qdrant vector database, as well as Jupyter Notebook for interactive development and data exploration.\n\n## Features\n\n- Python project structure with Pixi for dependency management\n- Docker Compose setup for easy development and deployment\n- Flask web application with hot-reloading for rapid development\n- Qdrant vector database integration\n- Watchdog for efficient file change detection in Docker\n- Jupyter Notebook for interactive development and data analysis\n\n## Prerequisites\n\nBefore you begin, ensure you have the following installed on your system:\n\n- [Docker](https://www.docker.com/get-started)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n- [Pixi](https://github.com/prefix-dev/pixi) (Optional: for local development without Docker)\n\n## Getting Started\n\n### Clone the Repository\n\n```bash\ngit clone git@github.com:mshaaban0/pixi-docker-template.git\ncd pixi-docker-template\n```\n\n### Running with Docker Compose\n\n1. Build and start the containers:\n\n```bash\ndocker compose up --build\n```\n\n2. Access the Flask application at `http://localhost:5001`\n\n3. Access Jupyter Notebook at `http://localhost:9999` (token is in the terminal output)\n\n4. Qdrant Dashboard at `http://localhost:6333/dashboard`\n\n5. To stop the containers, press `Ctrl+C` in the terminal or run:\n\n```bash\ndocker compose down\n```\n\n### Local Development with Pixi (Optional)\n\n1. Install dependencies:\n\n```bash\npixi install\n```\n\n2. Run the Flask application:\n\n```bash\npixi run start\n```\n\n3. Run Jupyter Notebook:\n\n```bash\npixi run jupyter\n```\n\n4. Access the Flask application at `http://localhost:5001`\n\n5. Access Jupyter Notebook at `http://localhost:9999`\n\n## Project Structure\n\n```\n.\n├── .dockerignore\n├── .gitignore\n├── docker-compose.yml\n├── Dockerfile\n├── pixi.toml\n├── README.md\n├── src\n│   └── main.py\n└── notebooks\n    └── example.ipynb\n```\n\n## Configuration\n\n- `pixi.toml`: Manages Python dependencies and project metadata\n- `Dockerfile`: Defines the Docker image for the Python application\n- `docker-compose.yml`: Orchestrates the application, Qdrant services, and Jupyter Notebook\n- `src/main.py`: Entry point for the Flask application\n- `notebooks/`: Directory for Jupyter notebooks\n\n## Development\n\nThe project is set up with hot-reloading, allowing you to see changes immediately without restarting the container. Simply edit the files in the `src` directory, and the application will reload automatically.\n\nFor data analysis and exploratory work, use Jupyter Notebook. You can create new notebooks in the `notebooks/` directory, which will be persisted even after stopping the Docker containers.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Pixi](https://github.com/prefix-dev/pixi) for dependency management\n- [Flask](https://flask.palletsprojects.com/) for the web framework\n- [Qdrant](https://qdrant.tech/) for vector similarity search\n- [Docker](https://www.docker.com/) for containerization\n- [Jupyter](https://jupyter.org/) for interactive computing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmshaaban0%2Fpixi-docker-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmshaaban0%2Fpixi-docker-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmshaaban0%2Fpixi-docker-template/lists"}