hubugs er en meget enkel Python klient til at arbejde med GitHub udstedelse tracker.
Konfiguration
Før du bruger hubugs skal du erklære dine indstillinger for godkendelse, så vi kan få adgang til API.
Du skal først definere dit GitHub brugernavn:
git config --global github.user brugernavn
Og så er du nødt til at definere din GitHub API token, kan dette findes i admin fanen hensyn til din GitHub kontoside:
git config --global github.token token
Bemærk
Hvis du ændrer din GitHub password dit github.token indstilling er ugyldig, og du skal indstille den igen.
Hvis du ønsker at indstille information godkendelsen fra kommandolinjen kan du bruge miljøvariabler GITHUB_USER og GITHUB_TOKEN. For eksempel:
GITHUB_USER = jnrowe GITHUB_TOKEN = xxx hubugs åben
Hacking
Patches og pull anmodninger er meget velkomne, men jeg ville sætte pris på det, hvis du kunne følge retningslinjerne nedenfor for at gøre det lettere at integrere dine ændringer. Disse er kun vejledende dog, og som sådan kan brydes, hvis behovet opstår, eller du blot ønsker at overbevise mig om, at din stil er bedre.
- PEP 8, stilen vejledning, bør følges, hvor det er muligt.
- Selv kan tilsættes støtte til Python versioner før v2.6 i fremtiden, hvis et sådant behov skulle opstå, opfordres du til at bruge v2.6 funktioner nu.
- Alle nye klasser, metoder og funktioner bør ledsages af nye doctest eksempler og reStructuredText formaterede beskrivelser.
- Prøverne skal ikke spænde netværk grænser, brug af en spottende ramme er acceptabel.
- doctest test i moduler er kun til test af enheder i almindelighed, og bør ikke stole på nogen moduler, der ikke er i Pythons standard bibliotek.
- Funktionelle test skal være i doc mappe i reStructuredText formaterede filer, med de faktiske test i doctest blokke. Funktionelle tests kan stole på eksterne moduler, men disse moduler skal være Open Source.
Nye eksempler på doc biblioteket er så værdsat som kode ændringer.
Bugs
Hvis du finder nogen problemer, bugs eller bare har et spørgsmål om denne pakke enten indgive et problem eller drop mig en mail.
Hvis du har fundet et problem skal du forsøge at omfatte en minimal testcase, så jeg kan genskabe problemet, eller endnu bedre en patch
Krav :
- Python
- argh
- github2
- Jinja
- Pygments
Kommentarer ikke fundet