@@ -108,72 +108,57 @@ Check out the changelog [here](CHANGELOG.md)
108108
109109## Developer setup instructions
110110
111- To do dev work on this repo:
111+ We recommend using [ uv ] ( https://pypi.org/project/uv/ ) for development work on this repo. (Preferably installed via one of the standalone installers)
112112
113- 1 . Check out the repo and make a virtual environment and activate it:
113+ 1 . Check out the repo.
114114
115115```
116116# original repo or make a fork and clone that if you want to contribute
117117
118118$ git clone git@github.com:PyBites-Open-Source/search.git
119+ ```
119120
120- $ cd search
121- √ search (main) $ python3 -m venv venv && source venv/bin/activate
121+ 2 . Activate the virtual environment
122+ * (This is optional if you run ** all your commands** with ` uv ` , but is a safer option if you are new to this workflow)*
123+ ```
124+ # Linux and macOS
125+ √ search (main) $ source venv/bin/activate
122126
123- # for Windows this would be something like:
124- py -3 -m venv venv && venv\scripts\activate
127+ # Windows
128+ √ search (main) $ . venv\scripts\activate
125129```
126130
127- 2 . Install the regular + test + tooling dependencies:
131+ 3 . Install dependencies (this will automatically include the * dev * dependency group)
128132
129133```
130- (venv) √ search (main) $ python -m pip install .
131- (venv) √ search (main) $ python -m pip install ".[test,tools]"
134+ (search) √ search (main) $ uv sync
132135```
133136
134- 3 . Use the tool / run the tests
137+ 4 . Use the tool / run the tests
135138
136139```
137- (venv ) √ search (main) $ search ...
140+ (search ) √ search (main) $ search ...
138141...
139142
140- (venv ) √ search (main) $ tox
143+ (search ) √ search (main) $ uv run pytest -vvv
141144...
142145...
143- py39: OK (15.89=setup[14.49]+cmd[1.40] seconds)
144- py310: OK (13.22=setup[11.80]+cmd[1.42] seconds)
145- py311: OK (10.42=setup[9.41]+cmd[1.01] seconds)
146- congratulations :) (39.61 seconds)
147- ```
148-
149- 4 . Code, have fun, contribute ... 💪 🙏
150-
151-
152- ### When using ` pixi ` use these instructions
153- 1 . Check out the repo
154- ```
155- git clone git@github.com:PyBites-Open-Source/search.git
156- cd search
157- ```
158-
159- 2 . Run the tool
160- ```
161- # Find fastapi mentions in all pybites content
162- pixi run all fastapi
163-
164- # Find fastapi only in the podcasts
165- pixi run podcast fastapi
166- ```
167-
168- 3 . Test on all python version
169- ```
170- # Installs and runs 3 test environments including different versions of python.
171- pixi run test
172-
173- # If you want to test one python version run
174- pixi run test39
175- pixi run test310
176- pixi run test311
177- ```
178-
179- 4 . Code, have fun, contribute ... 💪 🙏
146+ configfile: pyproject.toml
147+ plugins: cov-6.2.1
148+ collected 11 items
149+
150+ tests/test_all_content.py::test_all_search_match_content PASSED [ 9%]
151+ tests/test_all_content.py::test_all_search_show_matches PASSED [ 18%]
152+ tests/test_article.py::test_match_article_content PASSED [ 27%]
153+ tests/test_article.py::test_match_article_content_no_results PASSED [ 36%]
154+ tests/test_bite.py::test_match_bite_content PASSED [ 45%]
155+ tests/test_bite.py::test_match_bite_content_no_results PASSED [ 54%]
156+ tests/test_bite.py::test_match_bite_content_timeout PASSED [ 63%]
157+ tests/test_podcast.py::test_match_podcast_content PASSED [ 72%]
158+ tests/test_tip.py::test_match_tip_content PASSED [ 81%]
159+ tests/test_tip.py::test_show_tip_matches PASSED [ 90%]
160+ tests/test_youtube.py::test_match_video_content PASSED [100%]
161+
162+ ============================= 11 passed in 0.34s ==============================
163+
164+ 6. Code, have fun, contribute ... 💪 🙏
0 commit comments