PyBookLib est une bibliothèque en deux parties conçue pour héberger et obtenir des projets de code modèle. Il est écrit principalement pour les programmes Python, mais il est également possible d'héberger d'autres langages. PyBookLib possède deux sous-modules, chacun indépendant l'un de l'autre : PyBook et PyLib. PyBookLib n'a aucune affiliation avec les projets PyPI existants PyBook et PyLib. Il s’agit d’un projet complètement séparé, et il se trouve qu’il a pour thème la bibliothèque. ?
Vous pouvez installer le package comme suit :
pip install -U PyBookLib
Si vous voulez la dernière version de développement, qui contient très certainement des bugs, exécutez ce qui suit :
pip install git+https://github.com/BD103/PyBookLib
Pour extraire ce fichier de démarque dans la console, vous pouvez exécuter PyBookLib
dans la ligne de commande. L'exécution de pybook
ou pylib
donne une liste de commandes possibles avec chacune.
Le module principal PyBookLib n'a actuellement aucune fonction au-delà d'un pont de code et de l'affichage de ce fichier markdown dans la ligne de commande.
PyBookLib
La fonctionnalité principale de PyBook est de se connecter à une bibliothèque hébergée et de recevoir des livres (fichiers .zip
). La bibliothèque accessible est définie par une variable d'environnement. Essayez d'exécuter quelque chose comme ceci :
from PyBookLib import pybook
import os
# Set environmental variable for library. Unecessary but helpful all the same
pybook . set_url ( "https://library.bd103.repl.co/api" )
# Gets a book "sample-library" from the user "BD103" with the version "1.2" and extracts contents to the directory "pylib-library"
pybook . get ( user = "BD103" , book = "sample-library" , version = "1.2" , direc = "pylib-library" )
Avec ce script simple, il se connecte à library.bd103.repl.co et demande une bibliothèque d'échantillons. Ce livre est un exemple de script pour héberger votre propre bibliothèque. (Il a été créé pour Replit, c'est pourquoi il existe un pyproject.toml.)
Vous pouvez également exécuter certaines commandes bash :
# Get a list of commands
pybook --help
pybook get-book BD103 sample-library --version 1.2 --direc pylib-library
pybook get-user BD103
# This should automatically be set to library.bd103.repl.co/api
pybook set-url https://link.to.site/api
# Umbrella get function to specify exact details
pybook get --user BD103 --direc folder
Vous n'êtes pas obligé de spécifier tous ces paramètres. Essayez d'en supprimer et de remplacer certains d'entre eux et voyez ce qui se passe !
PyLib sert à héberger votre propre bibliothèque. C'est extrêmement simple. Installez PyBookLib et choisissez votre chemin :
Remarque : Ces chemins définiront automatiquement l'adresse IP et le port sur
0.0.0.0:8000
. Si vous êtes sur une machine locale, vous pouvez vous connecter via localhost:8000. Si vous utilisez un service d'hébergement de serveur, il devrait automatiquement définir l'hôte sur votre domaine. Si vous rencontrez des conflits avec le port ou souhaitez une adresse IP différente, vous pouvez la spécifier en prenant le chemin Python main.py et en remplaçantpylib.run()
parpylib.run(host="1.2.3.4", port=8080)
.
Créez un fichier appelé main.py. À l’intérieur, collez ce qui suit :
from PyBookLib import pylib
pylib . run ()
Exécutez le script pour commencer à héberger votre bibliothèque.
Dans la ligne de commande, exécutez ce qui suit :
pylib run
Regardez votre serveur être hébergé.
Si vous souhaitez contribuer à ce projet, rendez-vous sur github.com/BD103/ PyBookLib , créez un fork et une pull request. Tout le code doit être exécuté via les commandes suivantes :
black PyBookLib
isort PyBookLib --profile black
flake8 PyBookLib
PyTest n'est pas encore implémenté. Restez à l'écoute! ?