Skip to content

Commit

Permalink
0.0.9
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonycorletti committed Jun 24, 2023
1 parent 79319d0 commit f76ae11
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 33 deletions.
20 changes: 11 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,36 @@ You should see paths that use the `.venv/bin` in your current working directory.

## Installing dependencies

This project uses `pip` to manage our project's dependencies and all tasks are managed with `invoke`. Invoke is a python package that allows you to define tasks in a python file and run them from the command line, similar to `make` and `rake`, but with a pythonic syntax.

In your virtual environment, install `invoke` by running;
For your first ever install of `snok` you will need to run;

```sh
pip install invoke
pip install -e '.[dev]'
```

Then to install dependencies, run;
From then on, you can use `snok` to build `snok`!

```sh
snok install
```

```sh
inv install
snok add pendulum
```

## Linting

```sh
inv lint
snok lint
```

## Formatting

```sh
inv format
snok format
```

## Tests

```sh
inv test
snok test
```
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Snok is designed to leverage the best tools and packages that exist in the Pytho

## 🤩 Coming Soon

- Database integration with `pydantic` and `sqlmodel`
- Database integration with `pydantic`, `sqlmodel`, and `alembic`
- Web application generation with `fastapi` and `htmx`
- Production ready deployment stacks with `nix`, `docker`, `skaffold` and `kustomize`
- AI framework integrations with `pytorch` and `langchain`
Expand Down
34 changes: 11 additions & 23 deletions snok/templates/__shared/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,52 +34,40 @@ You should see paths that use `.venv/bin` in your current working directory.

## Dependencies

This project uses `invoke` to manage dependencies.
This project uses `snok` to manage dependencies.

In your virtual environment, install `invoke` by running;
In your virtual environment, install your dependencies by running;

```sh
pip install --upgrade pip && pip install invoke
```

Then to install the project's dependencies, run;

```sh
inv install
snok install
```

To add a specific dependency, run;

```sh
inv add <PACKAGE>
snok add <PACKAGE>
```

To remove a specific dependency, run;

```sh
inv rm <PACKAGE>
snok remove <PACKAGE>
```

## Tasks

All tasks are managed with `invoke`.

Invoke is a python package that allows you to define tasks in a python file and run them from the command line, similar to `make` and `rake`, but with a pythonic syntax. All tasks are located in the `tasks.py` file.

### Linting
## Linting

```sh
inv lint
snok lint
```

### Formatting
## Formatting

```sh
inv format
snok format
```

### Tests
## Tests

```sh
inv test
snok test
```

0 comments on commit f76ae11

Please sign in to comment.