Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ $ conda install cookiecutter
### The resulting directory structure
------------

The directory structure of your new project looks like this:
The directory structure of your new project looks like this:

```
├── LICENSE
Expand Down Expand Up @@ -63,8 +63,8 @@ The directory structure of your new project looks like this:
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
│ generated with `pip freeze > requirements.txt`
├── src <- Source code for use in this project.
│ ├── __init__.py <- Makes src a Python module
├── {{ cookiecutter.module_name }} <- Source code for use in this project.
│ ├── __init__.py <- Makes {{ cookiecutter.module_name }} a Python module
│ │
│ ├── data <- Scripts to download or generate data
│ │ └── make_dataset.py
Expand Down
1 change: 1 addition & 0 deletions cookiecutter.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"project_name": "project_name",
"repo_name": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
"module_name": "src",
"author_name": "Your name (or your organization/company/team)",
"description": "A short description of the project.",
"open_source_license": ["MIT", "BSD-3-Clause", "No license file"],
Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.repo_name }}/.env
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Environment variables go here, can be read by `python-dotenv` package:
#
# `src/script.py`
# `{{ cookiecutter.module_name }}/script.py`
# ----------------------------------------------------------------
# import dotenv
#
Expand Down
4 changes: 2 additions & 2 deletions {{ cookiecutter.repo_name }}/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ requirements: test_environment

## Make Dataset
data: requirements
$(PYTHON_INTERPRETER) src/data/make_dataset.py
$(PYTHON_INTERPRETER) -m {{ cookiecutter.module_name }}.data.make_dataset

## Delete all compiled Python files
clean:
Expand All @@ -36,7 +36,7 @@ clean:

## Lint using flake8
lint:
flake8 src
flake8 {{ cookiecutter.module_name }}

## Upload Data to S3
sync_data_to_s3:
Expand Down
6 changes: 3 additions & 3 deletions {{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ Project Organization
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
│ generated with `pip freeze > requirements.txt`
├── setup.py <- makes project pip installable (pip install -e .) so src can be imported
├── src <- Source code for use in this project.
│   ├── __init__.py <- Makes src a Python module
├── setup.py <- makes project pip installable (pip install -e .) so {{ cookiecutter.module_name }} can be imported
├── {{ cookiecutter.module_name }} <- Source code for use in this project.
│   ├── __init__.py <- Makes {{ cookiecutter.module_name }} a Python module
│ │
│   ├── data <- Scripts to download or generate data
│   │   └── make_dataset.py
Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.repo_name }}/setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from setuptools import find_packages, setup

setup(
name='src',
name='{{ cookiecutter.module_name }}',
packages=find_packages(),
version='0.1.0',
description='{{ cookiecutter.description }}',
Expand Down