Metadata-Version: 2.1
Name: dsfolder
Version: 0.0.0.2
Summary: Add your description here
Requires-Python: >=3.11
Description-Content-Type: text/markdown

## Data Science Folder Structure Setup

1. This was developed for creating a Python folder to start a data science project.

2. It includes preconfigured connections to different systems:
   - uv  
   - git  
   - GitHub workflow  
   - .gitignore  

3. It also provides small code snippets for connecting to other systems.

4. Below are some of the systems included, along with additional setup steps to get them working:
   - logging  
   - SQL  
   - src  
   - config  
   - pre-commit hook  
   - .gitignore  
   - git  
   - GitHub workflow  
   - uv  
   - env  
   - validation  
   - testing  
   - requirements.txt  
     - Install dependencies with: `uv install requirements.txt`


5. Install the package using either command:

   ```bash
   pip install datascience-folder-structure
   ```

   or

   ```bash
   pip install dsfolder
   ```

6. Create a folder structure using either command:

   ```bash
   createdatasciencefolder NameOfProject
   ```

   or the shorter alias:

   ```bash
   dsf NameOfProject
   ```

