hubugs is een zeer eenvoudige Python-client voor het werken met GitHub's issue tracker.
Configuratie
Voor het gebruik van hubugs moet u uw verificatie-instellingen te verklaren, zodat we kunnen toegang krijgen tot de API.
U moet eerst uw GitHub gebruikersnaam definiëren:
git config --global github.user gebruikersnaam
En dan moet je je GitHub API token te definiëren, deze zijn te vinden in de admin tabblad van je GitHub accountpagina rekening:
git config --global github.token token
Notitie
Als je je GitHub wachtwoord wijzigen van uw github.token instelling zijn ongeldig en moet u deze opnieuw instellen.
Als u de verificatie-informatie instellen vanaf de opdrachtregel kunt u de GITHUB_USER en GITHUB_TOKEN omgevingsvariabelen gebruiken. Bijvoorbeeld:
GITHUB_USER = jnrowe GITHUB_TOKEN = xxx geopend hubugs
Hacking
Patches en trek verzoeken zijn van harte welkom, maar ik zou het op prijs stellen als u de richtlijnen kon volgen hieronder om het gemakkelijker maken om uw wijzigingen te integreren. Dit zijn slechts richtlijnen echter, en als zodanig kan worden doorbroken als de noodzaak zich voordoet of wil je gewoon om mij te overtuigen dat uw stijl is beter.
- PEP 8, de stijlgids, moet waar mogelijk gevolgd.
- Terwijl de ondersteuning voor Python versies voor v2.6 kunnen worden toegevoegd in de toekomst als een dergelijke behoefte zich zou voordoen, wordt u aangemoedigd om nu v2.6 functies te gebruiken.
- Alle nieuwe klassen, methoden en functies moet gepaard gaan met nieuwe doctest voorbeelden en reStructuredText geformatteerd beschrijvingen.
- Proeven mag niet overspannen netwerk grenzen, gebruik van een spottende kader is aanvaardbaar.
- Doctest testen in modules zijn alleen bedoeld voor het testen van eenheid in het algemeen, en mag niet vertrouwen op een modules die niet in standaard bibliotheek Python's.
- Functionele tests moeten worden in de doc directory in reStructuredText geformatteerde bestanden, met de werkelijke tests doctest blokken. Functionele tests kunnen afhangen van externe modules, maar deze modules moet Open Source zijn.
Nieuwe voorbeelden voor de doc directory zijn zo gewaardeerd als wijzigingen in de code.
Bugs
Als je merkt dat er problemen, bugs of gewoon een vraag over dit pakket ofwel het indienen van een probleem of stuur me een mail.
Als u een probleem hebt gevonden dan kunt u proberen om een minimale testcase behoren dus ik kan het probleem te reproduceren, of beter nog een patch
Eisen :
- Python
- argh
- github2
- Jinja
- Pygments
Reacties niet gevonden