From e760e727a104d0bac6f5d4b0b5445fff2c3e7eb8 Mon Sep 17 00:00:00 2001 From: Tom Vo Date: Fri, 14 Apr 2023 14:54:46 -0700 Subject: [PATCH] Test instructions --- conda-env/ci.yml | 4 ++-- conda-env/dev.yml | 7 ++----- docs/conf.py | 6 +++--- {python_template => myproject}/__init__.py | 0 .../python_template.py => myproject/myproject.py | 0 setup.py | 8 ++++---- tests/{test_python_template.py => test_myproject.py} | 2 +- 7 files changed, 12 insertions(+), 15 deletions(-) rename {python_template => myproject}/__init__.py (100%) rename python_template/python_template.py => myproject/myproject.py (100%) rename tests/{test_python_template.py => test_myproject.py} (90%) diff --git a/conda-env/ci.yml b/conda-env/ci.yml index a8ac8b0..937b1fb 100644 --- a/conda-env/ci.yml +++ b/conda-env/ci.yml @@ -1,6 +1,6 @@ # Conda environment for CI/CD (used in GH Actions) # TODO: 1. Replace template in `name` with your library name -name: template-ci +name: myproject-ci channels: - conda-forge - defaults @@ -16,4 +16,4 @@ dependencies: # ========================================== - pytest # TODO: 3. Replace template in`prefix` with your library name -prefix: /opt/miniconda3/envs/template-ci +prefix: /opt/miniconda3/envs/myproject-ci diff --git a/conda-env/dev.yml b/conda-env/dev.yml index 44ed5be..086fc34 100644 --- a/conda-env/dev.yml +++ b/conda-env/dev.yml @@ -1,11 +1,9 @@ # Conda environment for local development # Usage: env create -f conda-env/dev.yml -# TODO: 1. Replace template in `name` with your library name -name: template-dev +name: myproject-dev channels: - conda-forge - defaults -# TODO: 2. Update and add dependencies as needed dependencies: # ========================================== # Base - for building this package @@ -30,5 +28,4 @@ dependencies: # Testing - for running unit tests # ========================================== - pytest -# TODO: 3. Replace template in `prefix` with your library name -prefix: /opt/miniconda3/env/template-dev +prefix: /opt/miniconda3/env/myproject-dev diff --git a/docs/conf.py b/docs/conf.py index b245329..e498808 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,7 @@ import sys sys.path.insert(0, os.path.abspath('..')) -import python_template +import myproject # -- General configuration --------------------------------------------- @@ -55,9 +55,9 @@ # the built documents. # # The short X.Y version. -version = python_template.__version__ +version = myproject.__version__ # The full version, including alpha/beta/rc tags. -release = python_template.__version__ +release = myproject.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/python_template/__init__.py b/myproject/__init__.py similarity index 100% rename from python_template/__init__.py rename to myproject/__init__.py diff --git a/python_template/python_template.py b/myproject/myproject.py similarity index 100% rename from python_template/python_template.py rename to myproject/myproject.py diff --git a/setup.py b/setup.py index c389886..7fd15a3 100644 --- a/setup.py +++ b/setup.py @@ -38,14 +38,14 @@ long_description=readme + "\n\n" + history, include_package_data=True, # TODO: Update keywords and name to your library name - keywords="python_template", - name="python_template", + keywords="myproject", + name="myproject", # TODO: Update include statement in packages to your library modules - packages=find_packages(include=["python_template", "python_template.*"]), + packages=find_packages(include=["myproject", "myproject.*"]), test_suite="tests", tests_require=test_requirements, # TODO: Update url to the library's GitHub URL - url="https://github.com/tomvothecoder/python-template-repo", + url="https://github.com/tomvothecoder/myproject", version="0.1.0", zip_safe=False, ) diff --git a/tests/test_python_template.py b/tests/test_myproject.py similarity index 90% rename from tests/test_python_template.py rename to tests/test_myproject.py index 27ddaa9..b2cbcfa 100644 --- a/tests/test_python_template.py +++ b/tests/test_myproject.py @@ -4,7 +4,7 @@ import pytest -from python_template import python_template # noqa: F401 +from myproject import myproject # noqa: F401 @pytest.fixture