You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-60Lines changed: 1 addition & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,32 +45,7 @@ This creates the directory async-search-client and connects your repository to t
45
45
46
46
Note: This project uses Poetry to manage dependencies. If you do not already have Poetry installed you will need to install it with the instuctions [here](https://python-poetry.org/docs/#installation)
47
47
48
-
Once you have cloned your fork of the repository you can create a virtual environment. When using Poetry the step is optional.
49
-
If you create a virtual environment Poetry will use the environment you have activated, or Poetry will create
50
-
and use it's own if you don't create one. If you want to create your own, once you are in the async-search-client directory create and activate
51
-
the virtual environment. This step is slightly different for Mac/Linux and Windows.
52
-
53
-
Mac/Linux
54
-
55
-
```sh
56
-
# Create the environment
57
-
python3 -m venv venv
58
-
59
-
# Activate the environment
60
-
. venv/bin/activate
61
-
```
62
-
63
-
Windows
64
-
65
-
```powershell
66
-
# Create the environment
67
-
python -m venv venv
68
-
69
-
#Activate the environment. Use activate.bat for cmd.exe
You can run linting on your code at any time with:
106
81
107
-
```sh
108
-
# Run isort
109
-
isort async_search_client tests
110
-
111
-
# Run black
112
-
black async_search_client tests
113
-
114
-
# Run flake8
115
-
flake8 async_search_client test
116
-
117
-
# Run mypy
118
-
mypy async_search_client
119
-
```
120
-
121
-
* Note if you did not create your own virtual environment and are using the Poetry environment instead you will need to append `poetry run ...` to each command.
If you want to see which lines are missing code coverage run the test with:
204
157
205
-
```sh
206
-
pytest --cov-report term-missing
207
-
```
208
-
209
-
or
210
-
211
158
```sh
212
159
poetry run pytest --cov-report term-missing
213
160
```
@@ -217,12 +164,6 @@ tests are passing before submitting a pull request.
217
164
218
165
tox can be used to run both linting, and run the tests in all versions of Python async-search-client supports. Note that you will need to have all the verions of Python installed for this to work.
0 commit comments