-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update repo name in readme and docs (#274)
- Loading branch information
Showing
2 changed files
with
14 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,11 +43,11 @@ pip install qctrl-open-controls | |
### From Source | ||
|
||
The source code is hosted on | ||
[Github](https://github.com/qctrl/python-open-controls). The repository can be | ||
[GitHub](https://github.com/qctrl/open-controls). The repository can be | ||
cloned using | ||
|
||
```shell | ||
git clone [email protected]:qctrl/python-open-controls.git | ||
git clone [email protected]:qctrl/open-controls.git | ||
``` | ||
|
||
Once the clone is complete, you have two options: | ||
|
@@ -61,23 +61,22 @@ Once the clone is complete, you have two options: | |
After you have installed Poetry, use: | ||
|
||
```bash | ||
cd python-open-controls | ||
cd open-controls | ||
poetry install | ||
``` | ||
|
||
1. Using pip | ||
|
||
```shell | ||
cd python-open-controls | ||
cd 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. | ||
`pytest` in the `open-controls` directory. | ||
|
||
```shell | ||
pytest | ||
|
@@ -129,7 +128,7 @@ Code is formatted, linted and checked using the following tools: | |
- [isort](https://github.com/timothycrosley/isort) | ||
- [mypy](http://mypy-lang.org/) | ||
|
||
These checks are run on all code merged to master, and may also be run locally from the python-open-controls | ||
These checks are run on all code merged to master, and may also be run locally from the open-controls | ||
directory: | ||
|
||
```shell | ||
|
@@ -146,7 +145,7 @@ See the [official documentation](https://pylint.readthedocs.io/en/latest/user_gu | |
for details. | ||
|
||
Black and isort, in addition to checking code, can also automatically apply fixes. To fix all code | ||
in the python-open-controls tree, run: | ||
in the open-controls tree, run: | ||
|
||
```shell | ||
isort | ||
|
@@ -166,13 +165,13 @@ With this, the checks will run every time that you commit code with | |
instead of when you commit changes, use `pre-commit install -t pre-push`. | ||
|
||
If you no longer wish to use `pre-commit`, you can uninstall it by running | ||
`pre-commit uninstall` in the `python-open-controls` directory (or by running | ||
`pre-commit uninstall` in the `open-controls` directory (or by running | ||
`pre-commit uninstall -t pre-push`, if you used the pre-push hooks). | ||
|
||
## Credits | ||
|
||
See | ||
[Contributors](https://github.com/qctrl/python-open-controls/graphs/contributors). | ||
[Contributors](https://github.com/qctrl/open-controls/graphs/contributors). | ||
|
||
## License | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,12 +33,12 @@ From Source | |
----------- | ||
|
||
The source code is hosted on | ||
`Github <https://github.com/qctrl/python-open-controls>`_. The repository can be | ||
`GitHub <https://github.com/qctrl/open-controls>`_. The repository can be | ||
cloned using | ||
|
||
.. code-block:: shell | ||
git clone [email protected]:qctrl/python-open-controls.git | ||
git clone [email protected]:qctrl/open-controls.git | ||
Once the clone is complete, you have two options: | ||
|
||
|
@@ -54,23 +54,22 @@ Once the clone is complete, you have two options: | |
|
||
.. code-block:: shell | ||
cd python-open-controls | ||
cd open-controls | ||
poetry install | ||
#. | ||
Using pip | ||
|
||
.. code-block:: shell | ||
cd python-open-controls | ||
cd 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. | ||
``pytest`` in the ``open-controls`` directory. | ||
|
||
.. code-block:: shell | ||
|