diff --git a/tests/test_govcookiecutter_injected_variables.py b/tests/test_govcookiecutter_injected_variables.py index dcdd91b..578db64 100644 --- a/tests/test_govcookiecutter_injected_variables.py +++ b/tests/test_govcookiecutter_injected_variables.py @@ -12,7 +12,7 @@ } ORGANISATION_HANDLE_COUNT = { '"{{ cookiecutter.organisation_handle }}"': 1, - "`{{ cookiecutter.organisation_handle }}`": 4, + "`{{ cookiecutter.organisation_handle }}`": 3, 'u"{{ cookiecutter.organisation_handle }}",': 0, '[u"{{ cookiecutter.organisation_handle }}"],': 0, '"{{ cookiecutter.organisation_handle }}",': 0, @@ -30,11 +30,11 @@ } REPO_NAME_COUNT = { '"{{ cookiecutter.repo_name }}",': 0, - "`{{ cookiecutter.repo_name }}`": 15, + "`{{ cookiecutter.repo_name }}`": 8, "`{{ cookiecutter.repo_name }}`,": 1, '"{{ cookiecutter.repo_name }}.tex",': 0, '"{{ cookiecutter.repo_name }}doc"': 1, - "{{ cookiecutter.repo_name }}": 10, + "{{ cookiecutter.repo_name }}": 4, } OVERVIEW_COUNT = { '"{{ cookiecutter.overview }}",': 0, @@ -53,10 +53,10 @@ } USING_R_YES_COUNT = { "https://github.com/lorenzwalthert/precommit": 2, - "`.lintr`": 1, - "`.Rprofile`": 1, - "`DESCRIPTION`": 2, - "`startup.R`": 1, + "`.lintr`": 0, + "`.Rprofile`": 0, + "`DESCRIPTION`": 0, + "`startup.R`": 0, } @@ -165,7 +165,7 @@ def recursive_open_and_count_search_terms( ( "repo_name", "repo_2", - {**REPO_NAME_COUNT, "{{ cookiecutter.repo_name }}": 11}, + {**REPO_NAME_COUNT, "{{ cookiecutter.repo_name }}": 5}, {"using_R": "Yes"}, ), ("overview", "overview_1", OVERVIEW_COUNT, {"using_R": "No"}), diff --git a/{{ cookiecutter.repo_name }}/.env b/{{ cookiecutter.repo_name }}/.env index 739bda8..c71f7d7 100644 --- a/{{ cookiecutter.repo_name }}/.env +++ b/{{ cookiecutter.repo_name }}/.env @@ -24,30 +24,15 @@ # Add environment variables for the `data` directories DIR_DATA=./data -DIR_DATA_EXTERNAL=./data/external -DIR_DATA_RAW=./data/raw -DIR_DATA_INTERIM=./data/interim -DIR_DATA_PROCESSED=./data/processed # Add environment variables for the `docs` directory DIR_DOCS=./docs -# Add environment variables for the `notebooks` directory -DIR_NOTEBOOKS=./notebooks - -# Add environment variables for the `outputs` directory -DIR_OUTPUTS=./outputs - # Add environment variable for package directory -DIR_COOKIECUTTER.REPO_NAME = ./{{ cookiecutter.repo_name }} +DIR_SRC = ./src # Add environment variables for the `src` directories -DIR_COOKIECUTTER.REPO_NAME_SRC=./{{ cookiecutter.repo_name }}/src -DIR_SRC_MAKE_DATA=./{{ cookiecutter.repo_name }}/src/make_data -DIR_SRC_MAKE_FEATURES=./{{ cookiecutter.repo_name }}/src/make_features -DIR_SRC_MAKE_MODELS=./{{ cookiecutter.repo_name }}/src/make_models -DIR_SRC_MAKE_VISUALISATIONS=./{{ cookiecutter.repo_name }}/src/make_visualisations -DIR_SRC_UTILS=./{{ cookiecutter.repo_name }}/src/utils +DIR_SRC_COOKIECUTTER.REPO_NAME=./src/{{ cookiecutter.repo_name }} # Add environment variables for the `tests` directory -DIR_COOKIECUTTER.REPO_NAME_TESTS=./{{ cookiecutter.repo_name }}/tests +DIR_TESTS=./tests diff --git a/{{ cookiecutter.repo_name }}/data/README.md b/{{ cookiecutter.repo_name }}/data/README.md index 54fbd5a..269f086 100644 --- a/{{ cookiecutter.repo_name }}/data/README.md +++ b/{{ cookiecutter.repo_name }}/data/README.md @@ -1,16 +1,11 @@ # `data` folder overview -Any data that needs to be stored locally should be saved in this location. This folder, -and its sub-folders, are not version-controlled. +Any data that needs to be stored locally should be saved in this location. -The sub-folders should be used as follows: - -- `external`: any data that will not be processed at all, such as reference data; -- `raw`: any raw data before any processing; -- `interim`: any raw data that has been partially processed and, for whatever reason, - needs to be stored before further processing is completed; and -- `processed`: any raw or interim data that has been fully processed into its final - state. +Most data files should not be pushed to your repository, therefore make +sure your .gitignore file excludes your data files from git commits. An +exemption to this may be an example data file that another user may use in +a tutorial for your package. The paths for these directories are loaded as environment variables by the `.envrc` file. To load them in Python, use any or all of the following code: @@ -20,8 +15,4 @@ import os # Load environment variables for the `data` folder, and its sub-folders DIR_DATA = os.getenv("DIR_DATA") -DIR_DATA_EXTERNAL = os.getenv("DIR_DATA_EXTERNAL") -DIR_DATA_RAW = os.getenv("DIR_DATA_RAW") -DIR_DATA_INTERIM = os.getenv("DIR_DATA_INTERIM") -DIR_DATA_PROCESSED = os.getenv("DIR_DATA_PROCESSED") ``` diff --git a/{{ cookiecutter.repo_name }}/data/external/.gitkeep b/{{ cookiecutter.repo_name }}/data/external/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/{{ cookiecutter.repo_name }}/data/interim/.gitkeep b/{{ cookiecutter.repo_name }}/data/interim/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/{{ cookiecutter.repo_name }}/data/processed/.gitkeep b/{{ cookiecutter.repo_name }}/data/processed/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/{{ cookiecutter.repo_name }}/data/raw/.gitkeep b/{{ cookiecutter.repo_name }}/data/raw/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/{{ cookiecutter.repo_name }}/docs/contributor_guide/writing_sphinx_documentation.md b/{{ cookiecutter.repo_name }}/docs/contributor_guide/writing_sphinx_documentation.md index 89d232c..030e31d 100644 --- a/{{ cookiecutter.repo_name }}/docs/contributor_guide/writing_sphinx_documentation.md +++ b/{{ cookiecutter.repo_name }}/docs/contributor_guide/writing_sphinx_documentation.md @@ -58,15 +58,6 @@ create a ReST file, and add the following line to reference the `{{ cookiecutter Then, elsewhere in the body, [call the `autosummary` directive to generate the docstrings as ReST stub files][sphinx-autosummary]. -```rest -.. autosummary:: - :toctree: api/ - - hello - world - -``` - [This will create something similar to the `pandas` API reference][pandas-api-reference]. @@ -95,17 +86,6 @@ create a Markdown file, and add the following line to reference the `{{ cookiecu Then, elsewhere in the body, [call the `autosummary` directive to generate the docstrings as ReST stub files][sphinx-autosummary]. -````md -```{eval-rst} -.. autosummary:: - :toctree: api/ - - hello - world - -``` -```` - ### Including Markdown files outside the `docs` folder [MyST lets you include Markdown files outside the `docs` folder][myst-include]. diff --git a/{{ cookiecutter.repo_name }}/docs/index.md b/{{ cookiecutter.repo_name }}/docs/index.md index 8e4234d..424cf46 100644 --- a/{{ cookiecutter.repo_name }}/docs/index.md +++ b/{{ cookiecutter.repo_name }}/docs/index.md @@ -9,6 +9,4 @@ self ./user_guide/README.md ./contributor_guide/README.md ./aqa/README.md -./structure/README.md -./reference/README.md ``` diff --git a/{{ cookiecutter.repo_name }}/docs/reference/README.md b/{{ cookiecutter.repo_name }}/docs/reference/README.md deleted file mode 100644 index d018b63..0000000 --- a/{{ cookiecutter.repo_name }}/docs/reference/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# `src` API reference - -This page gives an overview of all public `src` objects, functions and methods. All -classes and functions exposed in `src.*` namespace are public. - -```{toctree} -:maxdepth: 2 -./make_data.md -./make_features.md -./make_models.md -./make_visualisations.md -./utils.md -./src.md -``` diff --git a/{{ cookiecutter.repo_name }}/docs/reference/make_data.md b/{{ cookiecutter.repo_name }}/docs/reference/make_data.md deleted file mode 100644 index 4adfdbe..0000000 --- a/{{ cookiecutter.repo_name }}/docs/reference/make_data.md +++ /dev/null @@ -1,15 +0,0 @@ -# Data generation - -These `{{ cookiecutter.repo_name }}` package functions generate data. - -```{eval-rst} -.. currentmodule:: {{ cookiecutter.repo_name }} -``` - -## Function heading - -```{eval-rst} -.. autosummary:: - :toctree: api/ - -``` diff --git a/{{ cookiecutter.repo_name }}/docs/reference/make_features.md b/{{ cookiecutter.repo_name }}/docs/reference/make_features.md deleted file mode 100644 index 7beaef6..0000000 --- a/{{ cookiecutter.repo_name }}/docs/reference/make_features.md +++ /dev/null @@ -1,15 +0,0 @@ -# Feature generation - -These `{{ cookiecutter.repo_name }}` package functions create features. - -```{eval-rst} -.. currentmodule:: {{ cookiecutter.repo_name }} -``` - -## Function heading - -```{eval-rst} -.. autosummary:: - :toctree: api/ - -``` diff --git a/{{ cookiecutter.repo_name }}/docs/reference/make_models.md b/{{ cookiecutter.repo_name }}/docs/reference/make_models.md deleted file mode 100644 index 1a607a4..0000000 --- a/{{ cookiecutter.repo_name }}/docs/reference/make_models.md +++ /dev/null @@ -1,15 +0,0 @@ -# Model generation - -These `{{ cookiecutter.repo_name }}` package functions create models. - -```{eval-rst} -.. currentmodule:: {{ cookiecutter.repo_name }} -``` - -## Function heading - -```{eval-rst} -.. autosummary:: - :toctree: api/ - -``` diff --git a/{{ cookiecutter.repo_name }}/docs/reference/make_visualisations.md b/{{ cookiecutter.repo_name }}/docs/reference/make_visualisations.md deleted file mode 100644 index 72056f8..0000000 --- a/{{ cookiecutter.repo_name }}/docs/reference/make_visualisations.md +++ /dev/null @@ -1,15 +0,0 @@ -# Create visualisations - -These `{{ cookiecutter.repo_name }}` package functions create visualisations. - -```{eval-rst} -.. currentmodule:: {{ cookiecutter.repo_name }} -``` - -## Function heading - -```{eval-rst} -.. autosummary:: - :toctree: api/ - -``` diff --git a/{{ cookiecutter.repo_name }}/docs/reference/src.md b/{{ cookiecutter.repo_name }}/docs/reference/src.md deleted file mode 100644 index a4b4c4f..0000000 --- a/{{ cookiecutter.repo_name }}/docs/reference/src.md +++ /dev/null @@ -1,15 +0,0 @@ -# Package functions - -These are miscellaneous functions in the `{{ cookiecutter.repo_name }}` package. - -```{eval-rst} -.. currentmodule:: {{ cookiecutter.repo_name }} -``` - -## Function heading - -```{eval-rst} -.. autosummary:: - :toctree: api/ - -``` diff --git a/{{ cookiecutter.repo_name }}/docs/reference/utils.md b/{{ cookiecutter.repo_name }}/docs/reference/utils.md deleted file mode 100644 index 2dbfe22..0000000 --- a/{{ cookiecutter.repo_name }}/docs/reference/utils.md +++ /dev/null @@ -1,15 +0,0 @@ -# Create utility functions - -These `{{ cookiecutter.repo_name }}` package functions create utility functions. - -```{eval-rst} -.. currentmodule:: {{ cookiecutter.repo_name }} -``` - -## Function heading - -```{eval-rst} -.. autosummary:: - :toctree: api/ - -``` diff --git a/{{ cookiecutter.repo_name }}/docs/structure/README.md b/{{ cookiecutter.repo_name }}/docs/structure/README.md deleted file mode 100644 index 4a7158b..0000000 --- a/{{ cookiecutter.repo_name }}/docs/structure/README.md +++ /dev/null @@ -1,203 +0,0 @@ -# `{{ cookiecutter.repo_name }}` structure - -This page provides information on the repository's structure. The repository's folder -structure is explained here: - -```{toctree} -:maxdepth: 2 -./data.md -./docs.md -./notebooks.md -./outputs.md -./src.md -./tests.md -``` - -## Top-level files - -Each subsection here contains a brief description about the files at the top-level of -this Git repository. - -### `.env` - -Environment variables go here, and can be read in by Python using the `python-dotenv` package, and `os.getenv`: - -```in script -from dotenv import load_dotenv -import os - -#Load the environment variables from the `.env` file, overriding any system -#environment variables -load_dotenv(override=True) - -# Example variable -EXAMPLE_VARIABLE = os.getenv("EXAMPLE_VARIABLE") -``` - -### `.envrc` - -Orchestration file to load environment variables from the `.env` and `.secrets` files. -Only used by systems with `direnv` (https://direnv.net/) installed. Environment -variables can be read in by Python using `os.getenv` _without_ using `python-dotenv`: - -```in script -import os - -# Example variable -EXAMPLE_VARIABLE = os.getenv("EXAMPLE_VARIABLE") -``` - - -### `.flake8` - -A configuration file for the `flake8` Python package that provides linting. This file -is based on the [common configuration described in the GDS Way][gds-way-flake8]. - -### `.gitignore` - -A `.gitignore` file to ignore certain files and folders from this Git repository. [See -the contributor guide to modift the `.gitignore` file][docs-updating-gitignore]. - -{% if cookiecutter.using_R == "Yes" -%} -### `.lintr` - -R-specific configuration file for styling R code. - -{% endif -%} - -### `.pre-commit-config.yaml` - -[A pre-commit hook configuration file][docs-pre-commit-hooks]. - -{% if cookiecutter.using_R == "Yes" -%} -### `.Rprofile` - -R-specific initialisation file that runs automatically when starting R. - -{% endif -%} - -### `.secrets` - -A file to store all secrets and credentials as environment variables. [This file is -read-in by `.envrc`](#envrc), when [loading environment variables with the `direnv` -shell extension][direnv], but is not tracked by Git. - -### `.secrets.baseline` - -[Baseline file for the `detect-secrets` to detect secrets][detect-secrets]. In -conjunction with `pre-commit`, `detect-secrets` prevents secrets from being committed -to the repository. The baseline file flags secret-like data that the user deliberately -wishes to commit the to repository. - -### `CODE_OF_CONDUCT.md` - -[The Code of Conduct for contributors to this project][code-of-conduct], including -maintainers and `{{ cookiecutter.organisation_handle }}` organisation owners. - -### `conftest.py` - -File to contain shared fixture functions for the `pytest` tests in the `tests` folder. - -### `CONTRIBUTING.md` - -The contributing guidelines for this project. - -{% if cookiecutter.using_R == "Yes" -%} -### `DESCRIPTION` - -R-specific information related to the project including the name, authors and packages -necessary for the project. - -{% endif -%} - -### `LICENSE` - -The licence for this project. Unless stated otherwise, the codebase is released under -the MIT License. This covers both the codebase and any sample code in the -documentation. The documentation is © Crown copyright and available under the terms of -the Open Government 3.0 licence. - -### `Makefile` - -The `Makefile` contains a set of commands for the `make` utility. Run the `help` -command for further information at the top-level of the Git repository. - -```shell -make help -``` - -### `pyproject.toml` - -A file containing Python project settings. This includes configuration settings for: - -- [`isort`](#isort) -- [`pytest`](#pytest) -- [code coverage](#code-coverage) - -#### `isort` - -Python imports are arranged according to the [specification defined by `black`][black]. - -#### `pytest` - -To run the tests within the `tests` folder using the `pytest` Python package, enter -the following command: - -```shell -pytest -``` - -#### Code coverage - -To run code coverage using the `coverage` Python package with `pytest`, enter the -following command: - -```shell -coverage run -m pytest -coverage html -``` - -or using the `make` command: - -```shell -make coverage_html -``` - -A code coverage report in HTML will be produced on the code in the `src` folder. This -HTML report can be accessed at `htmlcov/index.html`. - -### `README.md` - -An overview of the Git repository, including all necessary instructions to run the code. - -### `requirements.txt` - -A list of Python package requirements for this Git repository, which can be installed -using the `pip install` command. - -```shell -pip install --requirement requirements.txt -``` - -Alternatively, to install the requirements file along with pre-commit hooks, run the -following command: - -```shell -make requirements -``` - -{% if cookiecutter.using_R == "Yes" -%} -### `startup.R` - -R-specific file that installs necessary packages specified in the `DESCRIPTION` file -upon starting R using `.Rprofile`. - -{% endif -%} - -[black]: https://black.readthedocs.io/en/stable/ -[code-of-conduct]:https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/CODE_OF_CONDUCT.md -[detect-secrets]: https://github.com/Yelp/detect-secrets -[direnv]: https://direnv.net/ -[docs-pre-commit-hooks]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/pre_commit_hooks.md -[docs-updating-gitignore]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/updating_gitignore.md -[gds-way-flake8]: https://gds-way.cloudapps.digital/manuals/programming-languages/python/python.html#common-configuration diff --git a/{{ cookiecutter.repo_name }}/docs/structure/data.md b/{{ cookiecutter.repo_name }}/docs/structure/data.md deleted file mode 100644 index f06a7ee..0000000 --- a/{{ cookiecutter.repo_name }}/docs/structure/data.md +++ /dev/null @@ -1,3 +0,0 @@ -```{include} ../../data/README.md -:relative-docs: ../docs/structure -``` diff --git a/{{ cookiecutter.repo_name }}/docs/structure/docs.md b/{{ cookiecutter.repo_name }}/docs/structure/docs.md deleted file mode 100644 index b95ce84..0000000 --- a/{{ cookiecutter.repo_name }}/docs/structure/docs.md +++ /dev/null @@ -1,3 +0,0 @@ -```{include} ../README.md -:relative-docs: ../docs -``` diff --git a/{{ cookiecutter.repo_name }}/docs/structure/notebooks.md b/{{ cookiecutter.repo_name }}/docs/structure/notebooks.md deleted file mode 100644 index b950f2c..0000000 --- a/{{ cookiecutter.repo_name }}/docs/structure/notebooks.md +++ /dev/null @@ -1,3 +0,0 @@ -```{include} ../../notebooks/README.md -:relative-docs: ../docs/structure -``` diff --git a/{{ cookiecutter.repo_name }}/docs/structure/outputs.md b/{{ cookiecutter.repo_name }}/docs/structure/outputs.md deleted file mode 100644 index f15500f..0000000 --- a/{{ cookiecutter.repo_name }}/docs/structure/outputs.md +++ /dev/null @@ -1,3 +0,0 @@ -```{include} ../../outputs/README.md -:relative-docs: ../docs/structure -``` diff --git a/{{ cookiecutter.repo_name }}/docs/structure/{{ cookiecutter.repo_name }}.md b/{{ cookiecutter.repo_name }}/docs/structure/{{ cookiecutter.repo_name }}.md deleted file mode 100644 index 6472d67..0000000 --- a/{{ cookiecutter.repo_name }}/docs/structure/{{ cookiecutter.repo_name }}.md +++ /dev/null @@ -1,3 +0,0 @@ -```{include} ../../{{ cookiecutter.repo_name }}/README.md -:relative-docs: ../docs/structure -``` diff --git a/{{ cookiecutter.repo_name }}/notebooks/README.md b/{{ cookiecutter.repo_name }}/notebooks/README.md deleted file mode 100644 index b657204..0000000 --- a/{{ cookiecutter.repo_name }}/notebooks/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# `notebooks` folder overview - -All Jupyter notebooks should be stored in this folder. - -The `.envrc` file should automatically add the entire project path into the -`PYTHONPATH` environment variable. This should allow you to directly import `src` in -your notebook. diff --git a/{{ cookiecutter.repo_name }}/outputs/README.md b/{{ cookiecutter.repo_name }}/outputs/README.md deleted file mode 100644 index 74fb5bc..0000000 --- a/{{ cookiecutter.repo_name }}/outputs/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# `outputs` folder overview - -All outputs from the project should be stored here. This folder path for these -directories is loaded as an environment variable by the `.envrc` file; to load them in -Python, use the following code: - -```python -import os - -# Load environment variables for the `outputs` folder -DIR_OUTPUTS = os.getenv("DIR_OUTPUTS") -``` diff --git a/{{ cookiecutter.repo_name }}/pyproject.toml b/{{ cookiecutter.repo_name }}/pyproject.toml index fb0484a..822946b 100644 --- a/{{ cookiecutter.repo_name }}/pyproject.toml +++ b/{{ cookiecutter.repo_name }}/pyproject.toml @@ -21,5 +21,5 @@ addopts = [ ] doctest_optionflags = "NORMALIZE_WHITESPACE" testpaths = [ - "./{{ cookiecutter.repo_name }}/tests" + "./tests" ] diff --git a/{{ cookiecutter.repo_name }}/setup.cfg b/{{ cookiecutter.repo_name }}/setup.cfg index dd957f6..1201da4 100644 --- a/{{ cookiecutter.repo_name }}/setup.cfg +++ b/{{ cookiecutter.repo_name }}/setup.cfg @@ -23,5 +23,6 @@ install_requires = Sphinx toml python_requires = >=3.6 - +package_dir = + =./src zip_safe = no diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/__init__.py b/{{ cookiecutter.repo_name }}/src/__init__.py similarity index 100% rename from {{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/__init__.py rename to {{ cookiecutter.repo_name }}/src/__init__.py diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/__init__.py b/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.repo_name }}/__init__.py similarity index 100% rename from {{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/__init__.py rename to {{ cookiecutter.repo_name }}/src/{{ cookiecutter.repo_name }}/__init__.py diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_data/__init__.py b/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.repo_name }}/utils/__init__.py similarity index 100% rename from {{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_data/__init__.py rename to {{ cookiecutter.repo_name }}/src/{{ cookiecutter.repo_name }}/utils/__init__.py diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/tests/README.md b/{{ cookiecutter.repo_name }}/tests/README.md similarity index 100% rename from {{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/tests/README.md rename to {{ cookiecutter.repo_name }}/tests/README.md diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_features/__init__.py b/{{ cookiecutter.repo_name }}/tests/__init__.py similarity index 100% rename from {{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_features/__init__.py rename to {{ cookiecutter.repo_name }}/tests/__init__.py diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/README.md b/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/README.md deleted file mode 100644 index e737ef5..0000000 --- a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# `src` package overview - -All functions for this project, should be stored in this folder. All tests should be -stored in the `tests` folder, which is one-level above this folder in the main project -directory. - -The sub-folders should be used as follows: - -- `make_data`: data processing-related functions -- `make_features`: feature-related functions, for example, functions to create features - from processed data -- `make_models`: model-related functions -- `make_visualisations`: functions to produce visualisations -- `utils`: utility functions that are helpful in the project - -Feel free to create/rename/delete these folders as required, as they will not be -necessary for each and every project. - -It is strongly suggested that you import functions in the `src/__init__.py` script. You -should also try to use absolute imports in this script whenever possible. Relative -imports are not discouraged, but can be an issue for projects where the directory -structure is likely to change. See [PEP 328 for details on absolute imports][pep-328]. - -[pep-328]: https://www.python.org/dev/peps/pep-0328/ diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_models/__init__.py b/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_models/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_visualisations/__init__.py b/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/make_visualisations/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/utils/__init__.py b/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/src/utils/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/tests/__init__.py b/{{ cookiecutter.repo_name }}/{{ cookiecutter.repo_name }}/tests/__init__.py deleted file mode 100644 index e69de29..0000000