{"id":24423065,"url":"https://github.com/sumit03guha/python-poetry-init","last_synced_at":"2025-03-13T14:24:23.926Z","repository":{"id":218925218,"uuid":"747713885","full_name":"sumit03guha/python-poetry-init","owner":"sumit03guha","description":"Introductory guide to python-poetry.","archived":false,"fork":false,"pushed_at":"2024-01-24T13:59:22.000Z","size":166,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-20T10:16:16.651Z","etag":null,"topics":["guide","introduction","poetry","poetry-python","python","python3","tutorial","web3py"],"latest_commit_sha":null,"homepage":"","language":"Python","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/sumit03guha.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}},"created_at":"2024-01-24T13:51:36.000Z","updated_at":"2024-01-24T14:01:00.000Z","dependencies_parsed_at":"2024-01-24T14:59:19.582Z","dependency_job_id":"ae7e796d-2a4d-4c22-81e7-c1ea50077266","html_url":"https://github.com/sumit03guha/python-poetry-init","commit_stats":null,"previous_names":["sumit03guha/python-poetry-init"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumit03guha%2Fpython-poetry-init","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumit03guha%2Fpython-poetry-init/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumit03guha%2Fpython-poetry-init/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumit03guha%2Fpython-poetry-init/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sumit03guha","download_url":"https://codeload.github.com/sumit03guha/python-poetry-init/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243420414,"owners_count":20288080,"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":["guide","introduction","poetry","poetry-python","python","python3","tutorial","web3py"],"created_at":"2025-01-20T10:16:25.487Z","updated_at":"2025-03-13T14:24:23.891Z","avatar_url":"https://github.com/sumit03guha.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Poetry Init Project\n\nThis project demonstrates the use of Poetry for managing Python dependencies and packaging. It includes an example application managed with Poetry, along with documentation on how to use Poetry and the advantages it offers.\n\n**Go to [init_poetry.md](./init_poetry.md) to setup and start using poetry.**\n\n## Documentation\n\n- [init_poetry.md](./init_poetry.md): Provides detailed instructions on how to install and use Poetry.\n- [why_poetry.md](./why_poetry.md): Explains the advantages and key features of using Poetry for Python dependency management and packaging.\n\n## Project Structure\n\n```shell\npython-poetry-init/\n┣ .gitignore        # Git ignore file\n┣ app.py            # Sample Python application\n┣ poetry.lock       # Lock file for deterministic builds\n┣ pyproject.toml    # Configuration file for Poetry\n┣ init_poetry.md    # Documentation on how to initialise and use Poetry\n┗ why_poetry.md     # Documentation on the benefits of using Poetry\n```\n\n## Getting Started\n\nTo get started with this project, you need to have Poetry installed on your system. You can find the installation instructions in [init_poetry.md](./init_poetry.md).\n\n### Installation\n\n1. Clone this repository:\n\n   ```shell\n   git clone https://github.com/sumit03guha/python-poetry-init\n   ```\n\n2. Navigate to the project directory:\n\n   ```shell\n   cd python-poetry-init\n   ```\n\n3. Install dependencies using Poetry:\n\n   ```shell\n   poetry install --no-root\n   ```\n\n### Running the Application\n\nTo run the sample application `app.py`, you can use the following steps:\n\n1. Activate the virtual environment managed by Poetry:\n\n   ```shell\n   poetry shell\n   ```\n\n   This command will spawn a shell within the virtual environment created for your project.\n\n2. Run the application:\n\n   ```shell\n   python app.py\n   ```\n\n   Inside the Poetry-managed virtual environment, you can run the application directly using Python.\n\nOR\n\n1. The application file can be run directly using the the following Poetry command.\n\n   ```shell\n   poetry run python app.py\n   ```\n\n### Exiting the Virtual Environment\n\nTo exit the virtual environment, simply type `exit` or close the terminal window.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsumit03guha%2Fpython-poetry-init","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsumit03guha%2Fpython-poetry-init","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsumit03guha%2Fpython-poetry-init/lists"}