Merge pull request #25 from SPARC-FAIR-Codeathon/PyPi

Add packaging related changes

Author: MMal151

ABOUT_THIS_TEMPLATE.md

@@ -1,5 +1,5 @@
 include LICENSE
 include HISTORY.md
 include Containerfile
-graft tests
-graft project_name
+include requirements.txt
+graft src/sparc_spy

MANIFEST.in

@@ -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 sparc_spy/
+	$(ENV_PREFIX)black -l 79 sparc_spy/
 	$(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 sparc_spy/
+	$(ENV_PREFIX)black -l 79 --check sparc_spy/
 	$(ENV_PREFIX)black -l 79 --check tests/
-	$(ENV_PREFIX)mypy --ignore-missing-imports project_name/
+	$(ENV_PREFIX)mypy --ignore-missing-imports sparc_spy/
 
 .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=sparc_spy -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}" > sparc_spy/VERSION
 	@$(ENV_PREFIX)gitchangelog > HISTORY.md
-	@git add project_name/VERSION HISTORY.md
+	@git add sparc_spy/VERSION HISTORY.md
 	@git commit -m "release: version $${TAG} 🚀"
 	@echo "creating git tag : $${TAG}"
 	@git tag $${TAG}
@@ -101,20 +101,23 @@ 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 "sparc_spy = 'sparc_spy.__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 sparc_spy'"
 
 .PHONY: init
 init:             ## Initialize the project based on an application template.
 	@./.github/init.sh
 
+.PHONY: build
+build:
+	@python3 -m build
 
 # This project has been generated from rochacbruno/python-project-template
 # __author__ = 'rochacbruno'

Makefile

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -30,15 +30,14 @@ def read_requirements(path):
     ]
 
 setup(
-    name="package_name",
-    version=read("src/package_name", "VERSION"),
-    description="project_description",
-    url="https://github.com/author_name/project_urlname/",
+    name="sparc_spy",
+    version=read("src/sparc_spy", "VERSION"),
+    description="A python tool to enhance the accessibility of SPARC scaffold visualisations and their analyses in accordance with FAIR principles.",
+    url="https://github.com/SPARC-FAIR-Codeathon/sparc-spy",
     long_description=read("README.md"),
     long_description_content_type="text/markdown",
-    author="author_name",
+    author="SPARC SPy Team",
     packages=find_packages(where='src'),
     package_dir={'': 'src'},
-    install_requires=read_requirements("requirements.txt"),
-    extras_require={"test": read_requirements("requirements-dev.txt")}
+    install_requires=read_requirements("requirements.txt")
 )