hubugs är en mycket enkel Python-klient för att arbeta med GitHub s emission tracker.
Konfiguration
Innan du använder hubugs du måste deklarera dina autentiseringsinställningar, så att vi kan få tillgång till API.
Du måste först definiera din GitHub användarnamn:
git config --global github.user användarnamn
Och sedan måste du definiera din GitHub API token, detta kan hittas i admin-fliken hänsyn till din GitHub kontosida:
git config --global github.token token
Notera
Om du ändrar ditt lösenord GitHub din github.token inställning är ogiltig, och du måste ställa in det igen.
Om du vill ställa in autentiseringsinformation från kommandoraden kan du använda GITHUB_USER och GITHUB_TOKEN miljövariabler. Till exempel:
GITHUB_USER = jnrowe GITHUB_TOKEN = xxx hubugs öppen
Hacking
Patchar och dra förfrågningar är välkomna, men jag skulle uppskatta om du kunde följa riktlinjerna nedan för att göra det enklare att integrera dina ändringar. Dessa är endast riktlinjer dock, och som sådan kan brytas om behov uppstår eller om du bara vill övertyga mig om att din stil är bättre.
- PEP 8, den stilguide, bör följas när det är möjligt.
- Medan stödet för Python-version före v2.6 kan läggas till i framtiden om ett sådant behov skulle uppstå, du uppmuntras att använda v2.6 funktioner nu.
- Alla nya klasser, metoder och funktioner bör åtföljas av nya doctest exempel och ReStructuredText formaterade beskrivningar.
- Tester får inte sträcka sig över nätverksgränserna, användning av en gäckande ram är acceptabelt.
- doctest tester i moduler är endast för enhetstestning i allmänhet, och bör inte förlita sig på några moduler som inte är i Pythons standardbibliotek.
- Funktionstester bör vara i katalogen doc i ReStructuredText formaterade filer, med verkliga tester i doctest block. Funktionella tester kan lita på externa moduler, men dessa moduler måste vara öppen källkod.
Nya exempel för doc katalogen är så uppskattat som kodändringar.
Bugs
Om du hittar några problem, buggar eller bara har en fråga om detta paket antingen lämna en fråga eller släpp mig ett mail.
Om du har hittat ett problem vänligen försök att inkludera en minimal testcase så jag kan återskapa problemet, eller ännu bättre en patch
Krav :
- Python
- argh
- github2
- Jinja
- Pygments
Kommentarer hittades inte