Skip to content

Commit

Permalink
build(chore): reorganize and update project dependencies and document…
Browse files Browse the repository at this point in the history
…ation

- added `packages/requirements.txt` and `packages/requirements-dev.txt` to organize dependencies and separate development requirements.
- added `packages/poetry.md` to document the usage of Poetry for dependency management.
- deleted the old `requirements.txt` from the root directory to align with the new structure.
- modified `pyproject.toml` to reflect updates in project dependencies.
- updated `poetry.lock` to lock the new dependencies and ensure consistency with the updated `pyproject.toml`.
  • Loading branch information
MohmdFo committed Aug 14, 2024
1 parent 4a3e8df commit ad49f49
Show file tree
Hide file tree
Showing 6 changed files with 979 additions and 758 deletions.
30 changes: 30 additions & 0 deletions packages/poetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
To export a `requirements-dev.txt` file containing both the main dependencies and the development dependencies from your `pyproject.toml` using Poetry, you can use the `--with` option to include the development dependencies.

Here is the command you can use:

```bash
poetry export -f requirements.txt --output requirements-dev.txt --with dev
```

Explanation:
- `-f requirements.txt`: Specifies the format of the output file.
- `--output requirements-dev.txt`: Specifies the name of the output file.
- `--with dev`: Includes the dependencies from the `dev` group.

This command will generate a `requirements-dev.txt` file that includes both the main dependencies and the development dependencies.

If you want to export the main dependencies to `requirements.txt` and the combined dependencies (main + dev) to `requirements-dev.txt`, you can use the following commands:

1. Export main dependencies to `requirements.txt`:

```bash
poetry export -f requirements.txt --output requirements.txt
```

2. Export main + dev dependencies to `requirements-dev.txt`:

```bash
poetry export -f requirements.txt --output requirements-dev.txt --with dev
```

This way, you'll have two separate files: `requirements.txt` for the main dependencies and `requirements-dev.txt` for both the main and development dependencies.
Loading

0 comments on commit ad49f49

Please sign in to comment.