Merge branch 'kyegomez:main' into main

Author: evelynmitchell

README.md

@@ -11,27 +11,13 @@ You can install the package using pip
 ```bash
 pip install -e .
 ```
-## Structure
-```
-├── LICENSE
-├── Makefile
-├── README.md
-├── agorabanner.png
-├── example.py
-├── package
-│   ├── __init__.py
-│   ├── main.py
-│   └── subfolder
-│       ├── __init__.py
-│       └── main.py
-├── pyproject.toml
-└── requirements.txt
-
-2 directories, 11 files
-```
+
 # Usage
+```python
+print("hello world")
+
+```
 
-# Documentation
 
 
 ### Code Quality 🧹
@@ -40,8 +26,8 @@ We provide two handy commands inside the `Makefile`, namely:
 
 - `make style` to format the code
 - `make check_code_quality` to check code quality (PEP8 basically)
-
-So far, **there is no types checking with mypy**. See [issue](https://github.com/roboflow-ai/template-python/issues/4). 
+- `black .`
+- `ruff . --fix`
 
 ### Tests 🧪
 
@@ -51,26 +37,11 @@ So far, **there is no types checking with mypy**. See [issue](https://github.com
 
 **Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
 
-We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier. You can publish by using
-
-```
-export PYPI_USERNAME="you_username"
-export PYPI_PASSWORD="your_password"
-export PYPI_TEST_PASSWORD="your_password_for_test_pypi"
-make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
-```
-
-You can also use token for auth, see [pypi doc](https://pypi.org/help/#apitoken). In that case,
-
 ```
-export PYPI_USERNAME="__token__"
-export PYPI_PASSWORD="your_token"
-export PYPI_TEST_PASSWORD="your_token_for_test_pypi"
-make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
+poetry build
+poetry publish
 ```
 
-**Note**: We will try to push to [test pypi](https://test.pypi.org/) before pushing to pypi, to assert everything will work
-
 ### CI/CD 🤖
 
 We use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`.
@@ -87,21 +58,11 @@ The **correct steps** to create a new realease are the following:
 The CI will run when you create the new release.
 
 # Docs
-We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs
-
-# Q&A
-
-## Why no cookiecutter?
-This is a template repo, it's meant to be used inside GitHub upon repo creation.
+We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs.
 
-## Why reinvent the wheel?
 
-There are several very good templates on GitHub, I prefer to use code we wrote instead of blinding taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.
-
-# Architecture
+# Tests
+`pytest`
 
 # License
 MIT
-
-
-