Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

moving all dev setup to contributing #11

Merged
merged 1 commit into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Contributing

## Setup

This project is built using the [Poetry](https://python-poetry.org/docs/) build tool.
First, install Poetry in your local environment via
```
curl -sSL https://install.python-poetry.org | python3 - -y
```
or see the [installation guide](https://python-poetry.org/docs/#installation)
for alternate installation methods.

Once Poetry is installed, you can install `flamingo` for development by running
```
poetry lock
poetry install
```
This will install an editable version of the package along with all of its dependency groups.
Poetry should recognize your active virtual environment during installation
and install the package dependencies there.

The `pyproject.toml` file defines dependency groups for the logical job types in the package.
Individual dependency groups can be installed by running
`poetry install --with <group1>,<group2>` or `poetry install --only <group>`.

Python should be [3.10, 3.11).

## Code style

This repository uses [Ruff](https://docs.astral.sh/ruff/) for Python formatting and linting.
Expand Down
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,12 @@ cluster environment (Ray cluster is running 3.10.8).

### Installation

This project is built using the [Poetry](https://python-poetry.org/docs/) build tool.
First, install Poetry in your local environment via
```
curl -sSL https://install.python-poetry.org | python3 - -y
```
or see the [installation guide](https://python-poetry.org/docs/#installation)
for more instructions.
run

Once Poetry is installed, you can install `flamingo` for development by running
```
poetry lock
poetry install
pip install flamingo (TODO-name update)
```

This will install an editable version of the package along with all of its dependency groups.

Poetry should recognize your active virtual environment during installation
Expand All @@ -43,11 +36,7 @@ poetry install
```
where `python3.10` is your python interpreter.

The `pyproject.toml` file defines dependency groups for the logical job types in the package.
Individual dependency groups can be installed by running
`poetry install --with <group1>,<group2>` or `poetry install --only <group>`.

See the [contributing](CONTRIBUTING.md) guide for more information on development workflows.
See the [contributing](CONTRIBUTING.md) guide for more information on development workflows and/or building locally.

### Usage

Expand Down