{"id":19989160,"url":"https://github.com/clamytoe/toepack","last_synced_at":"2025-05-04T09:32:39.550Z","repository":{"id":38095020,"uuid":"139166429","full_name":"clamytoe/toepack","owner":"clamytoe","description":"Bare minimum Python project templating system based on Cookiecutter.","archived":false,"fork":false,"pushed_at":"2023-11-08T15:35:36.000Z","size":58,"stargazers_count":16,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-16T01:53:26.577Z","etag":null,"topics":["cookiecutter","cookiecutter-python3","cookiecutter-template","package-creation","pytest","python3"],"latest_commit_sha":null,"homepage":null,"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/clamytoe.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}},"created_at":"2018-06-29T15:31:29.000Z","updated_at":"2023-10-18T11:17:08.000Z","dependencies_parsed_at":"2022-08-24T14:46:38.696Z","dependency_job_id":null,"html_url":"https://github.com/clamytoe/toepack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Ftoepack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Ftoepack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Ftoepack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Ftoepack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clamytoe","download_url":"https://codeload.github.com/clamytoe/toepack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224391419,"owners_count":17303609,"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":["cookiecutter","cookiecutter-python3","cookiecutter-template","package-creation","pytest","python3"],"created_at":"2024-11-13T04:45:40.026Z","updated_at":"2024-11-13T04:45:40.523Z","avatar_url":"https://github.com/clamytoe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Clamytoe's Package Template (*toepack*)\r\n\r\n\u003e *Simple Python project templating system based on Cookiecutter.*\r\n\r\n![Python version][python-version]\r\n![Latest version][latest-version]\r\n[![GitHub issues][issues-image]][issues-url]\r\n[![GitHub forks][fork-image]][fork-url]\r\n[![GitHub Stars][stars-image]][stars-url]\r\n[![License][license-image]][license-url]\r\n\r\nThe pack will create the basic framework for a command line utility that can easily be modified for other purposes. The following will be setup and configured for you:\r\n\r\n* Project structure\r\n* Generic Python .gitignore file\r\n* setup.py project file\r\n* MIT License\r\n* README.md with badges, like this README\r\n* Sample headers.py file for web scraping\r\n* Testing with Pytest, with initial test\r\n* Virtual environment support\r\n  * requirements.txt  ([venv](https://docs.python.org/3/library/venv.html))\r\n  * requirements-dev.txt\r\n  * environment.yml   ([conda](https://conda.io/docs/))\r\n\r\n## Initial setup\r\n\r\nThe first thing that you must do is have Cookiecutter installed.\r\n\r\n```zsh\r\npip install --user cookiecutter\r\n```\r\n\r\n## Usage\r\n\r\n```zsh\r\ncookiecutter https://github.com/clamytoe/toepack\r\n```\r\n\r\nAnswer the prompts or accept the defaults.\r\n\r\n### Alternate usage\r\n\r\nYou could also clone this repo and install it from that copy:\r\n\r\n```zsh\r\ngit clone https://github.com/clamytoe/toepack.git\r\ncookiecutter toepack\r\n```\r\n\r\n## What it does\r\n\r\nIf you accept the defaults to the initial questions, this is what the directory structure of your new project will look like:\r\n\r\n```zsh\r\n.\r\n├── LICENSE\r\n├── README.md\r\n├── environment.yml\r\n├── requirements-dev.txt\r\n├── requirements.txt\r\n├── setup.py\r\n├── tests\r\n│   ├── __init__.py\r\n│   └── test_toepack_clone.py\r\n└── toepack_clone\r\n    ├── __init__.py\r\n    └── app.py\r\n\r\n2 directories, 10 files\r\n```\r\n\r\nThe **toepack_clone** is the default name of the project and it will change to whatever you enter during that prompt.\r\n\r\n## Create your virtual environment\r\n\r\nNow that your project's structure has been created, you can now create a virtual environment to work from.\r\nThe README.md file that's created, will tell you how to create your it with normal python or with Anaconda.\r\n\r\n## License\r\n\r\nDistributed under the terms of the [MIT](https://opensource.org/licenses/MIT) license, \"toepack\" is free and open source software.\r\n\r\n## Issues\r\n\r\nIf you encounter any problems, please [file an issue](https://github.com/clamytoe/toepack/issues) along with a detailed description.\r\n\r\n## Changelog\r\n\r\n* **v0.4.3** Added support for dotenv.\r\n* **v0.4.2** Updated for the year 2023 and python 3.10.12.\r\n* **v0.4.1** Updated for the year 2022.\r\n* **v0.4.0** Removed logging fromt the project, I never really use it on my small scripts and always end up removed it.\r\n* **v0.3.1** Added flake8 to the requirements-dev.txt and environment.yml files.\r\n* **v0.3.0** Removed poetry support since I don't really use it and updated the cookiecutter.json file\r\n* **v0.2.8** Replaced instances of os.path with pathlib.Path and created a logs directory.\r\n* **v0.2.7** Added pyproject.toml for poetry support.\r\n* **v0.2.6** Removed unused linters, added mypy and version badge.\r\n* **v0.2.5** Removed hard set version numbers for the environment/requirement packages.\r\n* **v0.2.4** Added pytest-coverage to the developer dependencies and replaced flake8 with pycodestyle.\r\n* **v0.2.3** Fixed a bug with the logging setup. It would only read in config if project started from project directory.\r\n* **v0.2.2** Disabled logging during tests and prevented log level INFO from displaying in the console.\r\n* **v0.2.1** Added more detail to the README.md file.\r\n* **v0.2.0** Renamed the main script to *app.py*. I did not like the repeat name chaining..\r\n* **v0.1.3** Fixed bug in project_title variable name in the main script template.\r\n* **v0.1.2** Borrowed some setup.py code from [https://github.com/pypa/sampleproject](https://github.com/pypa/sampleproject)\r\n* **v0.1.1** Added changelog to README.md file.\r\n* **v0.1.0** Initial commit.\r\n\r\n[python-version]:https://img.shields.io/badge/python-3.10+-brightgreen.svg\r\n[latest-version]:https://img.shields.io/badge/version-0.4.0-blue.svg\r\n[issues-image]:https://img.shields.io/github/issues/clamytoe/toepack.svg\r\n[issues-url]:https://github.com/clamytoe/toepack/issues\r\n[fork-image]:https://img.shields.io/github/forks/clamytoe/toepack.svg\r\n[fork-url]:https://github.com/clamytoe/toepack/network\r\n[stars-image]:https://img.shields.io/github/stars/clamytoe/toepack.svg\r\n[stars-url]:https://github.com/clamytoe/toepack/stargazers\r\n[license-image]:https://img.shields.io/github/license/clamytoe/toepack.svg\r\n[license-url]:https://github.com/clamytoe/toepack/blob/master/LICENSE\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclamytoe%2Ftoepack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclamytoe%2Ftoepack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclamytoe%2Ftoepack/lists"}