hubugs er en veldig enkel Python klient for å arbeide med GitHub utgave tracker.
Konfigurasjon
Før du bruker hubugs må du erklære dine godkjenningsinnstillinger, slik at vi kan få tilgang til API.
Du må først definere din GitHub brukernavn:
git config --global github.user brukernavn
Og så må du definere din GitHub API token, kan dette bli funnet i administratorkontoens fanen på GitHub-konto side:
git config --global github.token token
Notat
Hvis du endrer GitHub passord github.token innstillingen vil være ugyldig, og du må sette den igjen.
Hvis du ønsker å stille inn autentiseringsinformasjon fra kommandolinjen kan du bruke GITHUB_USER og GITHUB_TOKEN miljøvariabler. For eksempel:
GITHUB_USER = jnrowe GITHUB_TOKEN = xxx hubugs åpen
Hacking
Patcher og pull forespørsler er hjertelig velkommen, men jeg ville sette pris på om du kunne følge retningslinjene nedenfor for å gjøre det enklere å integrere endringene. Dette er bare retningslinjer imidlertid, og som sådan kan brytes hvis behovet oppstår, eller du bare ønsker å overbevise meg om at stilen din er bedre.
- PEP 8, stilen guide, bør følges der det er mulig.
- Mens støtte for Python versjoner før v2.6 kan bli lagt i fremtiden dersom et slikt behov skulle oppstå, blir du oppfordret til å bruke v2.6 funksjoner nå.
- Alle nye klasser, metoder og funksjoner bør ledsages av nye doctest eksempler og reStructuredText formaterte beskrivelser.
- Tester må ikke strekke seg over nettverksgrenser, bruk av en tentamen rammeverket er akseptabelt.
- doctest tester i modulene er kun for enhetstesting generelt, og bør ikke stole på noen moduler som ikke er i Pythons standard bibliotek.
- Funksjonstester bør være i doc i reStructuredText formaterte filer, med faktiske tester i doctest blokker. Funksjonstester kan stole på eksterne moduler, men disse modulene må være Open Source.
Nye eksempler for doc katalogen er like verdsatt som kodeendringer.
Bugs
Hvis du finner noen problemer, bugs eller bare har et spørsmål om denne pakken enten sende inn en sak eller send meg en mail.
Hvis du har funnet et problem kan du forsøke å inkludere en minimal testcase slik at jeg kan gjenskape problemet, eller enda bedre en patch
Krav :
- Python
- argh
- github2
- Jinja
- Pygments
Kommentarer ikke funnet