Skip to content

feat: Use poetry.core to manage dependencies #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 18, 2022
Merged

feat: Use poetry.core to manage dependencies #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1f2be09
remove setup.py
tachikoma-li Mar 18, 2022
8523dbf
update gitignore
tachikoma-li Mar 18, 2022
6a2924a
more tweak
tachikoma-li Mar 18, 2022
fc4b4a5
list
tachikoma-li Mar 18, 2022
b9b155f
shell
tachikoma-li Mar 18, 2022
4a2843b
lint
tachikoma-li Mar 18, 2022
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
20 changes: 10 additions & 10 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,6 @@ git clone git@github.com:qctrl/python-open-controls.git

Once the clone is complete, you have two options:

1. Using setup.py

```shell
cd python-open-controls
python setup.py develop
```

**Note:** We recommend installing using `develop` to point your installation
at the source code in the directory where you cloned the repository.

1. Using Poetry

Follow the instructions from the
Expand All @@ -75,6 +65,16 @@ Once the clone is complete, you have two options:
poetry install
```

1. Using pip
Copy link
Contributor

@perjlieb perjlieb Mar 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Using pip
2. Using pip

Copy link
Member Author

@tachikoma-li tachikoma-li Mar 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are automatically numbered.


```shell
cd python-open-controls
poetry export --dev -f requirements.txt --output requirements.txt --without-hashes
pip install -r requirements.txt
pip install -e .
rm requirements.txt
```

Once installed via one of the above methods, test your installation by running
`pytest`
in the `python-open-controls` directory.
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ wheels/
*.egg-info/
.installed.cfg
*.egg
requirements.txt

# PyInstaller
# Usually these files are written by a python script from a template
Expand Down
16 changes: 0 additions & 16 deletions README.rst
View file
Open in desktop

This file was deleted.

22 changes: 11 additions & 11 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,6 @@ cloned using
Once the clone is complete, you have two options:


#.
Using setup.py

.. code-block:: shell

cd python-open-controls
python setup.py develop

**Note:** We recommend installing using ``develop`` to point your installation
at the source code in the directory where you cloned the repository.

#.
Using Poetry

Expand All @@ -68,6 +57,17 @@ Once the clone is complete, you have two options:
cd python-open-controls
poetry install

#.
Using pip

.. code-block:: shell

cd python-open-controls
poetry export --dev -f requirements.txt --output requirements.txt --without-hashes
pip install -r requirements.txt
pip install -e .
rm requirements.txt

Once installed via one of the above methods, test your installation by running
``pytest``
in the ``python-open-controls`` directory.
Expand Down
Loading