plate_package 0.0.2

No project description provided

Plate Package

.

🚀 Using

Prerequisites

1. Install Docker

1. Go to Docker, download and install docker.
2. Configure Docker to use the BuildKit build system. On macOS and Windows, BuildKit is enabled by default in Docker Desktop.

To install this package, run:

pip install plate_package

✨ Setup VSCode

Open this repo with VSCode, build DevContainer and Dev Containers: Reopen in Container.

✨ Setup PyCharm

Open this repo with PyCharm, and configure Docker Compose as a remote interpreter with the dev service.

🧑‍💻 Contributing

The following commands can be used inside a DevContainer.

Run linters

poe lint

Run tests

poe test

Update poetry lock file

poetry lock --no-update

Outside a DevContainer

1. Run linters

docker compose run devcontainer poe lint

2. Run tests

docker compose run devcontainer poe test

3. Update poetry lock file

docker compose run devcontainer poetry lock --no-update
# Update the docker image with the new lock file
docker compose build

4. Open a shell in docker

docker compose run devcontainer

Shortcuts outside a DevContainer

1. make lint
2. make test
3. make lock
4. make shell

---

️⚡️ Scaffolded with Poetry Copier
🛠️ Open an issue if you have any questions or suggestions.