-
Notifications
You must be signed in to change notification settings - Fork 8
Initialize py-libp2p Universal Connectivity Workshop #3
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
Draft
paschal533
wants to merge
19
commits into
libp2p:main
Choose a base branch
from
paschal533:py-libp2p-en-workshop
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
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.
Description
This pull request initializes the workshop for teaching Python programmers how to build a universal connectivity application using
py-libp2p
. It implements Step 1 (setting up the workshop structure and dependencies) and Step 2 (creating the first foundation lessons). The workshop is designed to be interactive, engaging, and suitable for a classroom setting, with a structure that complies with theWORKSHOP_AUTHORING.md
guidelines.Changes Introduced
Step 1: Workshop Structure and Dependencies
uc-workshop/py/
directory structure to house the workshop content.deps.py
to check for required Python dependencies (e.g., Python 3.8+,py-libp2p
, and other necessary libraries).setup.md
with clear instructions for setting up the Python environment and creating a new project for the workshop.Step 2: Foundation Lessons (1)
py-libp2p
.lesson.md
: Detailed explanation of libp2p identity concepts with practical exercises.lesson.yaml
: Metadata for the lesson (title, description, status).check.py
: Script to validate the participant's implementation of a basic host.app/Dockerfile
: Docker configuration for running the lesson code.docker-compose.yaml
: Configuration for containerized execution and output logging.stdout.log
: Placeholder for capturing lesson output.Key Features
WORKSHOP_AUTHORING.md
.check.py
) provide automated validation of participant solutions.Testing
deps.py
correctly identifies required dependencies.py-libp2p
installed.check.py
scripts accurately validate participant solutions.Additional Notes
py-libp2p
library is experimental and under active development. This workshop accounts for its current state and focuses on stable features.Checklist
uc-workshop/py/
directory structure.deps.py
for dependency checking.setup.md
with setup instructions.WORKSHOP_AUTHORING.md
guidelines.