{"id":15372359,"url":"https://github.com/reorx/project_sketch","last_synced_at":"2025-04-15T12:31:52.288Z","repository":{"id":29394060,"uuid":"32929243","full_name":"reorx/project_sketch","owner":"reorx","description":"A nerd's boilerplate for your Python project.","archived":false,"fork":false,"pushed_at":"2020-10-15T13:04:06.000Z","size":15,"stargazers_count":18,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T21:12:25.351Z","etag":null,"topics":["boilerplate","project","python","template"],"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/reorx.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":"2015-03-26T13:35:22.000Z","updated_at":"2024-10-25T16:19:34.000Z","dependencies_parsed_at":"2022-09-18T16:01:00.419Z","dependency_job_id":null,"html_url":"https://github.com/reorx/project_sketch","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/reorx%2Fproject_sketch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reorx%2Fproject_sketch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reorx%2Fproject_sketch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reorx%2Fproject_sketch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reorx","download_url":"https://codeload.github.com/reorx/project_sketch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249072306,"owners_count":21208163,"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":["boilerplate","project","python","template"],"created_at":"2024-10-01T13:50:27.993Z","updated_at":"2025-04-15T12:31:51.975Z","avatar_url":"https://github.com/reorx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# project_sketch\n\nA nerd's boilerplate for your Python project.\n\n\n## Usage\n\n```bash\n$ cp -r project_sketch \u003cyour_projects_name\u003e\n$ cd \u003cyour_projects_name\u003e\n$ mv project_sketch \u003cyour_projects_name\u003e\n```\n\nAnd change every `project_sketch` word into `\u003cyour_projects_name\u003e`.\n\n\n## Hierarchy\n\n```\nproject_sketch\n├── project_sketch\n│   ├── _module\n│   │   └── __init__.py\n│   └── __init__.py\n├── .gitignore\n├── setup.py\n├── Makefile\n├── manage.py\n├── requirements.txt\n├── dev-requirements.txt\n└── README.md\n```\n\n## Explanation\n\n- **project_sketch/**\n\n  The Python package of this project, mostly has the same name with root folder\n\n- **project_sketch/__init__.py**\n\n  Essential file to claim a package, contains `__version__` variable.\n\n- **project_sketch/_module/**\n\n  A submodule of the project, there's also a necessary `__init__.py` under it.\n\n  you can `cp _module whatever-you-like` to create a new submodule.\n\n- **.gitignore**\n\n  Simple, effective gitignore, much less verbose than\n  [this windbag](https://github.com/github/gitignore/blob/master/Python.gitignore)\n\n- **setup.py**\n\n  You may hate it, but you can't ignore it. This `setup.py` does just what you want,\n  and it automatically involves `requirements.txt` and `README.md`.\n\n  If you rock, go and dig [this](https://pinboard.in/u:reorx/t:python/t:packaging).\n\n- **Makefile**\n\n  We love Makefile, not Rakefile nor Gruntfile nor whatever requires extra program.\n  This awesome Makefile contains three commands at your service:\n\n  * `make build`\n\n    Build Python package with `setup.py`.\n\n  * `make clean`\n\n    Clean files \u0026 folders generated by `build`.\n\n  * `make test`\n\n    Run tests (if you have any) with nose.\n\n- **manage.py**\n\n  Try `pip install click` \u0026 `./manage.py ping` to see how it works.\n\n  If you are writing something that needs to run in a complicated way,\n  and you realize that this sort of code should not be put in the package,\n  this is what you need. `manage.py` is an entrance script which you can customize\n  your own command in it. By default, it uses [click](http://click.pocoo.org/3/)\n  to define commands \u0026 options, you can replace it by other things like\n  [docopt](http://docopt.org/), or [fabric](http://www.fabfile.org/)\n  (the file should be named `fabfile.py` then), if you prefer.\n\n  If you are writing a pure import-only package, feel free to remove it.\n\n- **requirements.txt**\n\n  Includes a `click` by default, this file contains packages your project depends on.\n\n- **dev-requirements.txt**\n\n  Includes a `nose` by default, this file contains packages you need in developing environment,\n  which are not necessary in production.\n\n- **README.md**\n\n  A cute, well formatted `README.md` makes people happy.\n  (True heros love `README.rst` :).\n\n\n## Questions and Answers\n\nQ: Why there's no `MANIFEST.in` file in the directory?\n\nQ: Why there's no `setup.cfg` file in the directory?\n\nQ: How to build and publish a distribution?\n\nQ: Should I use wheel as my distribution format?\n\n\u003e Could be answered from http://python-packaging-user-guide.readthedocs.org/en/latest/distributing/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freorx%2Fproject_sketch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freorx%2Fproject_sketch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freorx%2Fproject_sketch/lists"}