Skip to content
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.

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

Skeletonified client #61

Merged
merged 77 commits into from
Oct 20, 2023
Merged

Skeletonified client #61

merged 77 commits into from
Oct 20, 2023

Conversation

evalott100
Copy link
Contributor

@evalott100 evalott100 commented Oct 17, 2023

Closes #57

Skeletonified pandablocks, moved docs to the new structure.

The new docs publishing is working, they can be viewed here.

coretl and others added 30 commits January 7, 2022 11:46
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [black](https://github.com/psf/black) from 22.6.0 to 22.8.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.6.0...22.8.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
There are now developer and user guides. The version switcher is native
to the theme so added a script to generate it.
This saves another runner starting up just for this
Fixing a bug that occurs when releasing. (This is already fixed in the skeleton-cli project but failed to get copied to skeleton).
Pin pydata-sphinx-theme to allow the build to complete
pydata/pydata-sphinx-theme#987
Use the official Python Packaging Authority (PyPA) Action to publish to PyPI
Bumps [black](https://github.com/psf/black) from 22.8.0 to 22.10.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@22.8.0...22.10.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Translate punctuation and unicode in branch names to _
- Environment variable no longer needs to be set
- All commands run with tox-direct by default
- All environment variables passed through
- Moved wheel and sdist creation to the dist job
- Rely on the test matrix to run tests
- Simplified container build to make minimal for build and runtime
  and use wheel from 'dist': only publish to GHCR for tagged builds
- Create separate requirements-*.txt for each of the test matrix
- Fix actions-gh-pages version and don't run it for dependabot
- Move Dockerfile to .devcontainer and use as context to improve
  build times
- Other minor improvements and simplifications
@evalott100 evalott100 marked this pull request as draft October 17, 2023 12:22
@codecov
Copy link

codecov bot commented Oct 17, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0226e54) 96.34% compared to head (ddb7b01) 96.35%.
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #61      +/-   ##
==========================================
+ Coverage   96.34%   96.35%   +0.01%     
==========================================
  Files          12       12              
  Lines        1175     1180       +5     
==========================================
+ Hits         1132     1137       +5     
  Misses         43       43              
Files Coverage Δ
src/pandablocks/__init__.py 100.00% <100.00%> (ø)
src/pandablocks/__main__.py 0.00% <ø> (ø)
src/pandablocks/_control.py 85.39% <ø> (ø)
src/pandablocks/_exchange.py 100.00% <ø> (ø)
src/pandablocks/asyncio.py 97.34% <ø> (ø)
src/pandablocks/blocking.py 97.43% <ø> (ø)
src/pandablocks/cli.py 91.25% <ø> (ø)
src/pandablocks/commands.py 96.88% <ø> (ø)
src/pandablocks/connections.py 98.98% <ø> (ø)
src/pandablocks/hdf.py 97.39% <ø> (ø)
... and 2 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@evalott100 evalott100 marked this pull request as ready for review October 18, 2023 11:04
@evalott100 evalott100 force-pushed the skeletonified-client branch 2 times, most recently from 15d32d8 to d34b755 Compare October 18, 2023 12:21
Copy link
Contributor

@AlexanderWells-diamond AlexanderWells-diamond left a comment

Choose a reason for hiding this comment

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

A couple of bits to clean up

docs/user/explanations/sans-io.rst Show resolved Hide resolved
docs/user/tutorials/installation.rst Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
src/pandablocks/__init__.py Show resolved Hide resolved
tests/test_asyncio.py Outdated Show resolved Hide resolved
Copy link
Contributor

@AlexanderWells-diamond AlexanderWells-diamond left a comment

Choose a reason for hiding this comment

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

Classifier needs fixing

pyproject.toml Outdated Show resolved Hide resolved
@AlexanderWells-diamond
Copy link
Contributor

It's not strictly required in this PR, but I'll mention it here: There needs to be a redirect set up from the old documentation site (https://pandablocks-client.readthedocs.io/en/stable/index.html), to the new GitHub pages one.

This might be doable using this project, but that was designed to work with DiamondLightSource organization so may require some tweaking. Or doing it manually.

@evalott100
Copy link
Contributor Author

It's not strictly required in this PR, but I'll mention it here: There needs to be a redirect set up from the old documentation site (https://pandablocks-client.readthedocs.io/en/stable/index.html), to the new GitHub pages one.

This might be doable using this project, but that was designed to work with DiamondLightSource organization so may require some tweaking. Or doing it manually.

I can make a ticket for this. What's the purpose of this though - is it just to ensure links to the docs already in place in other projects will redirect to the new link?

@AlexanderWells-diamond
Copy link
Contributor

I can make a ticket for this. What's the purpose of this though - is it just to ensure links to the docs already in place in other projects will redirect to the new link?

Exactly that - we want any links that may be left lying around in odd places, e.g. third party documentation, or wikis, to always go to the right place.

@evalott100
Copy link
Contributor Author

Created a ticket #62

Copy link
Contributor

@AlexanderWells-diamond AlexanderWells-diamond left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@evalott100 evalott100 merged commit 7117d68 into master Oct 20, 2023
19 checks passed
@evalott100 evalott100 deleted the skeletonified-client branch October 20, 2023 13:25
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.

Use python3-pip-skeleton
9 participants