Skip to content

Commit

Permalink
📝 add init info in the readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseRZapata committed Feb 12, 2024
1 parent daca2d7 commit 3bca010
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 16 deletions.
11 changes: 0 additions & 11 deletions hooks/post_gen_project.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/usr/bin/env python
import os
import shutil
import subprocess # nosec

PROJECT_DIRECTORY = os.path.realpath(os.path.curdir)

Expand Down Expand Up @@ -33,13 +32,3 @@ def remove_dir(filepath: str) -> None:
remove_file(".github/workflows/docs.yml")
if codecov != "y":
remove_file("codecov.yml")


if not os.path.exists(".cruft.json"):
text_msg = """
Install \033[1;32m Make \033[0m and run next steps to set git and environment:
🎉 Init git in local: \033[1;32m make init_git \033[0m
🎉 Init Environment: \033[1;32m make init_env \033[0m
"""
subprocess.run(["echo", "-e", text_msg], check=False) # nosec
16 changes: 11 additions & 5 deletions {{cookiecutter.repo_name}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ Template for notebooks | [Notebook template] |

## Set up the environment

1. Initialize git in local:

```bash
make init_git
```

1. Set up the environment:

```bash
Expand All @@ -34,21 +40,21 @@ Template for notebooks | [Notebook template] |
1. Install libraries for data science and machine learning:

```bash
make install_all_libs
make install_data_libs
```

## Install dependencies

To install all dependencies for this project, run:
Agfter init the environment to install a new package, run:

```bash
poetry install
poetry add <package-name>
```

To install a new package, run:
Example to install [plotly](https://plotly.com/python/) in dev group:

```bash
poetry add <package-name>
poetry add plotly -G dev
```

## 🗃️ Project structure
Expand Down

0 comments on commit 3bca010

Please sign in to comment.