course and workshop material and cli enhancement - #42
Merged
lnauta merged 92 commits intoSep 19, 2025
Conversation
xinan1911
reviewed
Sep 8, 2025
xinan1911
reviewed
Sep 8, 2025
xinan1911
reviewed
Sep 8, 2025
xinan1911
reviewed
Sep 8, 2025
xinan1911
reviewed
Sep 8, 2025
xinan1911
reviewed
Sep 8, 2025
Collaborator
Author
|
@lnauta i think i addressed all your comments. tnx alot :) |
xinan1911
reviewed
Sep 15, 2025
hailihu
requested changes
Sep 15, 2025
hailihu
left a comment
Collaborator
There was a problem hiding this comment.
I reviewed the changes related to poetry/packaging and tested the short local example. Some comments and questions.
| couchdb = "^1.2" | ||
| stopit = "^1.1.2" | ||
| setuptools = "^66" | ||
| setuptools = "^80" |
Collaborator
There was a problem hiding this comment.
I am not sure why, but i am getting this warning now when pushing tokens to the DB (or any command that connects to DB):
% python push_tokens.py quick
.../lib/python3.10/site-packages/couchdb/__init__.py:15: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
__version__ = __import__('pkg_resources').get_distribution('CouchDB').version
Could this be because of the version change in setuptools?
Contributor
|
Check the notebooks and it looks fine. Need to test them again after the merge. |
This was referenced Sep 19, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces notebook based tutorials for the upcoming workshop. The notebooks follow the examples of the README and are appended with a walk through.
In addition to the tutorials a local development couchdb environment is added that is optional and can be used for local testing and development of the Picas client and CouchDB integration. It adds a Makefile for workflow automation, a Docker Compose configuration for CouchDB, a shell script to automate CouchDB initialization.
Tutorials and onboarding:
- 00-environment-setup.ipynb
- 01-database-setup.ipynb
- 02-local-run.ipynb
- 03-spider-run.ipynb
- 04-slurm-snellius.ipynb
Development workflow automation:
Makefilewith targets for building, installing, cleaning, testing, running tutorials, and managing Docker Compose services, enabling streamlined local development and reproducible builds.CouchDB service and initialization:
docker-compose.ymlfor running CouchDB and a setup container, including extensive documentation for common CouchDB operations and user/database setup.init_couchdb_user.shscript to automate CouchDB initialization: waits for CouchDB readiness, creates database and user if missing, configures security, and sets up the Monitor view.Add the picas-cli executable helper / wrapper script to initialize a configuration and change the couchdb password
Fix many style issues and add annotations and improve the documentation