https://github.com/ickc/naive-cookiecutter
https://github.com/ickc/naive-cookiecutter
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ickc/naive-cookiecutter
- Owner: ickc
- License: bsd-3-clause
- Created: 2021-12-08T00:41:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-22T23:00:25.000Z (almost 4 years ago)
- Last Synced: 2025-02-05T11:36:40.485Z (over 1 year ago)
- Language: Makefile
- Size: 33.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
.. This is auto-generated from `docs/README.md`. Do not edit this file directly.
========================================================================
naive_cookiecutter—just a naive cookiecutter to bootstrap Python project
========================================================================
:Date: August 22, 2022
.. contents::
:depth: 3
..
|Documentation Status| |image1|
|GitHub Actions| |Coverage Status| |image2| |Codacy Code Quality Status| |Scrutinizer Status| |CodeClimate Quality Status|
|Supported versions| |Supported implementations| |PyPI Wheel|
|PyPI Package latest release| |GitHub Releases| |Development Status| |Downloads|
|Commits since latest release| |License|
Introduction
============
naive_cookiecutter is just a naive cookiecutter to bootstrap Python project.
Instruction
===========
.. code:: bash
NEW_NAME=...
NEW_VERSION=...
NEW_YEAR=...
NEW_NAME_UPPER="$(echo $NEW_NAME | tr '[:lower:]' '[:upper:]')"
find . \! -path '*/.git/*' -type f -exec sed -i "s/naive_cookiecutter/$NEW_NAME/g" {} +
find . \! -path '*/.git/*' -type f -exec sed -i "s/NAIVE_COOKIECUTTER/$NEW_NAME_UPPER/g" {} +
find . \! -path '*/.git/*' -type f -exec sed -i "s/0.1.0/$NEW_VERSION/g" {} +
find . \! -path '*/.git/*' -type f -exec sed -i "s/2021–2022/$NEW_YEAR/g" {} +
mv src/naive_cookiecutter "src/$NEW_NAME"
mv tests/test_naive_cookiecutter.py "tests/test_$NEW_NAME.py"
- update title in
- ``docs/README.md``
- ``pyproject.toml``
Optionally also sed
- GitHub username ``ickc``
- author name ``Kolen Cheung``
- author email ``christian.kolen@gmail.com``
Copy
====
.. code:: bash
rsync -av --stats --exclude .git ./ $TARGET_GIT_REPO_DIRECTORY
.. |Documentation Status| image:: https://readthedocs.org/projects/naive_cookiecutter/badge/?version=latest
:target: https://naive_cookiecutter.readthedocs.io/en/latest/?badge=latest&style=plastic
.. |image1| image:: https://github.com/ickc/naive_cookiecutter/workflows/GitHub%20Pages/badge.svg
:target: https://ickc.github.io/naive_cookiecutter
.. |GitHub Actions| image:: https://github.com/ickc/naive_cookiecutter/workflows/Python%20package/badge.svg
.. |Coverage Status| image:: https://codecov.io/gh/ickc/naive_cookiecutter/branch/master/graphs/badge.svg?branch=master
:target: https://codecov.io/github/ickc/naive_cookiecutter
.. |image2| image:: https://coveralls.io/repos/ickc/naive_cookiecutter/badge.svg?branch=master&service=github
:target: https://coveralls.io/r/ickc/naive_cookiecutter
.. |Codacy Code Quality Status| image:: https://img.shields.io/codacy/grade/078ebc537c5747f68c1d4ad3d3594bbf.svg
:target: https://www.codacy.com/app/ickc/naive_cookiecutter
.. |Scrutinizer Status| image:: https://img.shields.io/scrutinizer/quality/g/ickc/naive_cookiecutter/master.svg
:target: https://scrutinizer-ci.com/g/ickc/naive_cookiecutter/
.. |CodeClimate Quality Status| image:: https://codeclimate.com/github/ickc/naive_cookiecutter/badges/gpa.svg
:target: https://codeclimate.com/github/ickc/naive_cookiecutter
.. |Supported versions| image:: https://img.shields.io/pypi/pyversions/naive_cookiecutter.svg
:target: https://pypi.org/project/naive_cookiecutter
.. |Supported implementations| image:: https://img.shields.io/pypi/implementation/naive_cookiecutter.svg
:target: https://pypi.org/project/naive_cookiecutter
.. |PyPI Wheel| image:: https://img.shields.io/pypi/wheel/naive_cookiecutter.svg
:target: https://pypi.org/project/naive_cookiecutter
.. |PyPI Package latest release| image:: https://img.shields.io/pypi/v/naive_cookiecutter.svg
:target: https://pypi.org/project/naive_cookiecutter
.. |GitHub Releases| image:: https://img.shields.io/github/tag/ickc/naive_cookiecutter.svg?label=github+release
:target: https://github.com/ickc/naive_cookiecutter/releases
.. |Development Status| image:: https://img.shields.io/pypi/status/naive_cookiecutter.svg
:target: https://pypi.python.org/pypi/naive_cookiecutter/
.. |Downloads| image:: https://img.shields.io/pypi/dm/naive_cookiecutter.svg
:target: https://pypi.python.org/pypi/naive_cookiecutter/
.. |Commits since latest release| image:: https://img.shields.io/github/commits-since/ickc/naive_cookiecutter/v0.1.0.svg
:target: https://github.com/ickc/naive_cookiecutter/compare/v0.1.0...master
.. |License| image:: https://img.shields.io/pypi/l/naive_cookiecutter.svg