Skip to content

Several quality of life changes, refactoring, and method for documentation#37

Open
paigeadelethompson wants to merge 1 commit intoParzivalHack:mainfrom
paigeadelethompson:paigeat-dev-staging
Open

Several quality of life changes, refactoring, and method for documentation#37
paigeadelethompson wants to merge 1 commit intoParzivalHack:mainfrom
paigeadelethompson:paigeat-dev-staging

Conversation

@paigeadelethompson
Copy link

  • refactored to use pyproject.toml; deleted requirements.txt, setup.cfg, and setup.py, so there's just one--pyproject.toml
  • cargo fmt'd rust source; readability
  • added rust artifacts to gitignore
  • add dev dependencies to pyproject.toml; black, flake8, pytest. Added bs4 to dev dependencies (reporting test)
  • reformatted python code with black; readability
  • add doc generation workflow; cargo doc and sphinx; API docs get generated for both and you can customize the docs starting from docs/source/index.rst

I imagined this might be a bit much, and so I retained the if original commits for all of the changes in a separate branch, then rebased into this staging branch (signed the rebased commit) and the original unabridged commits can be found here: https://github.com/paigeadelethompson/PySpector/tree/paigeat-dev

I would not be opposed to further enhancing the documentation, but I wanted to see how you felt about this approach, specifically with documentation in docblocks and generating web-based documentation from that with sphinx. I kinda wanted to touch all of these subjects for my own benefit so if you're feeling picky, that's okay because I will probably use this again as an example for my own projects :)

…fg, and setup.py, so there's just one--pyproject.toml

- cargo fmt'd rust source; readability
- added rust artifacts to gitignore
- add dev dependencies to pyproject.toml; black, flake8, pytest. Added bs4 to dev dependencies (reporting test)
- reformatted python code with black; readability
- add doc generation workflow; cargo doc and sphinx; API docs get generated for both and you can customize the docs
starting from docs/source/index.rst
@paigeadelethompson
Copy link
Author

lemme know if you want more specific commits, I can stage another pull request or just provide diffs :)

@paigeadelethompson
Copy link
Author

paigeadelethompson commented Mar 2, 2026

Also I meant to mention I could also add workflows for running pytest, and its also possible with black to only check to see if it would reformat code; so you can use it as a validation step as well (basically the validation step will fail if the committer doesn't re-format code before committing but like I said I just want to see what your feelings are about some of this stuff first.

I also meant to mention I noticed that the repo used to have a GH pages site: https://parzivalhack.github.io/PySpector but I also noticed that the source for it was apparently removed at some point and the deployment was maybe never deleted? I basically setup the document generation to deploy to GH pages but if you have some other way you prefer to do that, let me know

I would also say if possible test everything before merge. I tested this to the best of my ability but I don't have anything to test it with that I know should work or any API keys ATM, just because of the amount of code that cargo fmt and black tends to touch when neither have ever been used I've never had a problem with either of them and the only problems I usually have are usually just related to imports though this did not seem to be a problem in this case for what little I could test.

@ParzivalHack
Copy link
Owner

Hey @paigeadelethompson , thanks for this crazy PR. It will take me quite some time to review this fully, and understand which changes i'd like to implement, and which not, so i only ask for a bit of patience while i review this. Thanks again for this crazy PR, ill get back to you asap :)

@paigeadelethompson
Copy link
Author

No worries take as much time as you need I'll be around if you need any changes feel free to send it back and I'll update you :)

@satoridev01
Copy link
Contributor

@paigeadelethompson
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants