✅ Ready to clone and code.

jkobject · Oct 27, 2023 · 0321276 · 0321276
1 parent 022f33f
commit 0321276
Show file tree

Hide file tree

Showing 17 changed files with 55 additions and 56 deletions.
diff --git a/.github/rename_project.sh b/.github/rename_project.sh
@@ -16,10 +16,10 @@ echo "Description: $description";
 
 echo "Renaming project..."
 
-original_author="author_name"
-original_name="project_name"
-original_urlname="project_urlname"
-original_description="project_description"
+original_author="jkobject"
+original_name="scprint"
+original_urlname="scPRINT"
+original_description="Awesome scprint created by jkobject"
 # for filename in $(find . -name "*.*") 
 for filename in $(git ls-files) 
 do
@@ -30,7 +30,7 @@ do
     echo "Renamed $filename"
 done
 
-mv project_name $name
+mv scprint $name
 
 # This command runs only once on GHA!
 rm -rf .github/template.yml
diff --git a/.github/template.yml b/.github/template.yml
diff --git a/ABOUT_THIS_TEMPLATE.md b/ABOUT_THIS_TEMPLATE.md
@@ -32,7 +32,7 @@ Lets take a look at the structure of this template:
 ├── Makefile                 # A collection of utilities to manage the project
 ├── MANIFEST.in              # A list of files to include in a package
 ├── mkdocs.yml               # Configuration for documentation site
-├── project_name             # The main python package for the project
+├── scprint             # The main python package for the project
 │   ├── base.py              # The base module for the project
 │   ├── __init__.py          # This tells Python that this is a package
 │   ├── __main__.py          # The entry point for the project
@@ -109,7 +109,7 @@ I had to do some tricks to read that version variable inside the setuptools
 I decided to keep the version in a static file because it is easier to read from
 wherever I want without the need to install the package.
 
-e.g: `cat project_name/VERSION` will get the project version without harming
+e.g: `cat scprint/VERSION` will get the project version without harming
 with module imports or anything else, it is useful for CI, logs and debugging.
 
 ### Why to include `tests`, `history` and `Containerfile` as part of the release?

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,16 +1,16 @@
 # How to develop on this project
 
-project_name welcomes contributions from the community.
+scprint welcomes contributions from the community.
 
 **You need PYTHON3!**
 
 This instructions are for linux base systems. (Linux, MacOS, BSD, etc.)
 ## Setting up your own fork of this repo.
 
 - On github interface click on `Fork` button.
-- Clone your fork of this repo. `git clone [email protected]:YOUR_GIT_USERNAME/project_urlname.git`
-- Enter the directory `cd project_urlname`
-- Add upstream repo `git remote add upstream https://github.com/author_name/project_urlname`
+- Clone your fork of this repo. `git clone [email protected]:YOUR_GIT_USERNAME/scPRINT.git`
+- Enter the directory `cd scPRINT`
+- Add upstream repo `git remote add upstream https://github.com/jkobject/scPRINT`
 
 ## Setting up your own virtual environment
 

diff --git a/Containerfile b/Containerfile
@@ -2,4 +2,4 @@ FROM python:3.7-slim
 COPY . /app
 WORKDIR /app
 RUN pip install .
-CMD ["project_name"]
+CMD ["scprint"]
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,4 +2,4 @@ include LICENSE
 include HISTORY.md
 include Containerfile
 graft tests
-graft project_name
+graft scprint
diff --git a/Makefile b/Makefile
@@ -26,20 +26,20 @@ install:          ## Install the project in dev mode.
 
 .PHONY: fmt
 fmt:              ## Format code using black & isort.
-	$(ENV_PREFIX)isort project_name/
-	$(ENV_PREFIX)black -l 79 project_name/
+	$(ENV_PREFIX)isort scprint/
+	$(ENV_PREFIX)black -l 79 scprint/
 	$(ENV_PREFIX)black -l 79 tests/
 
 .PHONY: lint
 lint:             ## Run pep8, black, mypy linters.
-	$(ENV_PREFIX)flake8 project_name/
-	$(ENV_PREFIX)black -l 79 --check project_name/
+	$(ENV_PREFIX)flake8 scprint/
+	$(ENV_PREFIX)black -l 79 --check scprint/
 	$(ENV_PREFIX)black -l 79 --check tests/
-	$(ENV_PREFIX)mypy --ignore-missing-imports project_name/
+	$(ENV_PREFIX)mypy --ignore-missing-imports scprint/
 
 .PHONY: test
 test: lint        ## Run tests and generate coverage report.
-	$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=project_name -l --tb=short --maxfail=1 tests/
+	$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=scprint -l --tb=short --maxfail=1 tests/
 	$(ENV_PREFIX)coverage xml
 	$(ENV_PREFIX)coverage html
 
@@ -78,9 +78,9 @@ virtualenv:       ## Create a virtual environment.
 release:          ## Create a new tag for release.
 	@echo "WARNING: This operation will create s version tag and push to github"
 	@read -p "Version? (provide the next x.y.z semver) : " TAG
-	@echo "$${TAG}" > project_name/VERSION
+	@echo "$${TAG}" > scprint/VERSION
 	@$(ENV_PREFIX)gitchangelog > HISTORY.md
-	@git add project_name/VERSION HISTORY.md
+	@git add scprint/VERSION HISTORY.md
 	@git commit -m "release: version $${TAG} 🚀"
 	@echo "creating git tag : $${TAG}"
 	@git tag $${TAG}
@@ -101,15 +101,15 @@ switch-to-poetry: ## Switch to poetry package manager.
 	@poetry init --no-interaction --name=a_flask_test --author=rochacbruno
 	@echo "" >> pyproject.toml
 	@echo "[tool.poetry.scripts]" >> pyproject.toml
-	@echo "project_name = 'project_name.__main__:main'" >> pyproject.toml
+	@echo "scprint = 'scprint.__main__:main'" >> pyproject.toml
 	@cat requirements.txt | while read in; do poetry add --no-interaction "$${in}"; done
 	@cat requirements-test.txt | while read in; do poetry add --no-interaction "$${in}" --dev; done
 	@poetry install --no-interaction
 	@mkdir -p .github/backup
 	@mv requirements* .github/backup
 	@mv setup.py .github/backup
 	@echo "You have switched to https://python-poetry.org/ package manager."
-	@echo "Please run 'poetry shell' or 'poetry run project_name'"
+	@echo "Please run 'poetry shell' or 'poetry run scprint'"
 
 .PHONY: init
 init:             ## Initialize the project based on an application template.

diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ See also
 - ✅ Code linting using [flake8](https://flake8.pycqa.org/en/latest/)
 - 📊 Code coverage reports using [codecov](https://about.codecov.io/sign-up/)
 - 🛳️ Automatic release to [PyPI](https://pypi.org) using [twine](https://twine.readthedocs.io/en/latest/) and github actions.
-- 🎯 Entry points to execute your program using `python -m <project_name>` or `$ project_name` with basic CLI argument parsing.
+- 🎯 Entry points to execute your program using `python -m <scprint>` or `$ scprint` with basic CLI argument parsing.
 - 🔄 Continuous integration using [Github Actions](.github/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments.
 
 > Curious about architectural decisions on this template? read [ABOUT_THIS_TEMPLATE.md](ABOUT_THIS_TEMPLATE.md)  
@@ -51,33 +51,33 @@ See also
 <!--  DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -->
 
 ---
-# project_name
+# scprint
 
-[![codecov](https://codecov.io/gh/author_name/project_urlname/branch/main/graph/badge.svg?token=project_urlname_token_here)](https://codecov.io/gh/author_name/project_urlname)
-[![CI](https://github.com/author_name/project_urlname/actions/workflows/main.yml/badge.svg)](https://github.com/author_name/project_urlname/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/jkobject/scPRINT/branch/main/graph/badge.svg?token=scPRINT_token_here)](https://codecov.io/gh/jkobject/scPRINT)
+[![CI](https://github.com/jkobject/scPRINT/actions/workflows/main.yml/badge.svg)](https://github.com/jkobject/scPRINT/actions/workflows/main.yml)
 
-project_description
+Awesome scprint created by jkobject
 
 ## Install it from PyPI
 
 ```bash
-pip install project_name
+pip install scprint
 ```
 
 ## Usage
 
 ```py
-from project_name import BaseClass
-from project_name import base_function
+from scprint import BaseClass
+from scprint import base_function
 
 BaseClass().base_method()
 base_function()
 ```
 
 ```bash
-$ python -m project_name
+$ python -m scprint
 #or
-$ project_name
+$ scprint
 ```
 
 ## Development

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,2 +1,2 @@
-site_name: project_name
+site_name: scprint
 theme: readthedocs
diff --git a/project_name/__main__.py b/project_name/__main__.py
diff --git a/project_name/VERSION → scprint/VERSION b/project_name/VERSION → scprint/VERSION
diff --git a/project_name/__init__.py → scprint/__init__.py b/project_name/__init__.py → scprint/__init__.py
diff --git a/scprint/__main__.py b/scprint/__main__.py
@@ -0,0 +1,6 @@
+"""Entry point for scprint."""
+
+from scprint.cli import main  # pragma: no cover
+
+if __name__ == "__main__":  # pragma: no cover
+    main()
diff --git a/project_name/base.py → scprint/base.py b/project_name/base.py → scprint/base.py
@@ -1,7 +1,7 @@
 """
-project_name base module.
+scprint base module.
 
-This is the principal module of the project_name project.
+This is the principal module of the scprint project.
 here you put your main classes and objects.
 
 Be creative! do whatever you want!
@@ -14,4 +14,4 @@
 """
 
 # example constant variable
-NAME = "project_name"
+NAME = "scprint"
diff --git a/project_name/cli.py → scprint/cli.py b/project_name/cli.py → scprint/cli.py
@@ -1,4 +1,4 @@
-"""CLI interface for project_name project.
+"""CLI interface for scprint project.
 
 Be creative! do whatever you want!
 
@@ -12,7 +12,7 @@
 def main():  # pragma: no cover
     """
     The main function executes on commands:
-    `python -m project_name` and `$ project_name `.
+    `python -m scprint` and `$ scprint `.
 
     This is your program's entry point.
 

diff --git a/setup.py b/setup.py
@@ -1,12 +1,12 @@
-"""Python setup.py for project_name package"""
+"""Python setup.py for scprint package"""
 import io
 import os
 from setuptools import find_packages, setup
 
 
 def read(*paths, **kwargs):
     """Read the contents of a text file safely.
-    >>> read("project_name", "VERSION")
+    >>> read("scprint", "VERSION")
     '0.1.0'
     >>> read("README.md")
     ...
@@ -30,17 +30,17 @@ def read_requirements(path):
 
 
 setup(
-    name="project_name",
-    version=read("project_name", "VERSION"),
-    description="project_description",
-    url="https://github.com/author_name/project_urlname/",
+    name="scprint",
+    version=read("scprint", "VERSION"),
+    description="Awesome scprint created by jkobject",
+    url="https://github.com/jkobject/scPRINT/",
     long_description=read("README.md"),
     long_description_content_type="text/markdown",
-    author="author_name",
+    author="jkobject",
     packages=find_packages(exclude=["tests", ".github"]),
     install_requires=read_requirements("requirements.txt"),
     entry_points={
-        "console_scripts": ["project_name = project_name.__main__:main"]
+        "console_scripts": ["scprint = scprint.__main__:main"]
     },
     extras_require={"test": read_requirements("requirements-test.txt")},
 )
diff --git a/tests/test_base.py b/tests/test_base.py
@@ -1,5 +1,5 @@
-from project_name.base import NAME
+from scprint.base import NAME
 
 
 def test_base():
-    assert NAME == "project_name"
+    assert NAME == "scprint"