Skip to content

Commit b233ccd

Browse files
crobinsocrobinso
committed
Change links to point to github, make things more github friendly
1 parent cbc79e0 commit b233ccd

7 files changed

Lines changed: 45 additions & 51 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,37 @@
1-
Hackers Guide
2-
=============
3-
4-
1. Setting up the environment
5-
-----------------------------
1+
# Setting up the environment
62

73
If you already have system installed versions of python-bugzilla
84
dependencies, running the command line from git is as simple as doing:
5+
96
cd python-bugzilla.git
107
./bugzilla-cli [arguments]
118

12-
If you'd like to use pip and virtualenv to install a local development
9+
If you want to use pip and virtualenv to install a local development
1310
environment, use the following command.
11+
1412
source contrib/activate-dev-env [python2|python3]
1513

16-
Note: Providing no arguments will attempt to use python2.
14+
Then you can manually activate an environment with:
1715

18-
# Manually activating an environment
1916
source dev-env-${NAME}/bin/activate
2017

2118

22-
2. Running tests
23-
----------------
19+
# Running tests
20+
2421
Once you have already activated an environment, you can use the following.
2522

26-
# Basic unit test suite
23+
## Basic unit test suite
24+
2725
python setup.py test
2826

29-
# Read-Only Functional tests
27+
## Read-Only Functional tests
3028
There are more comprehensive tests that are disabled by default. Readonly
3129
functional tests that run against several public bugzilla instances. No
3230
login account is required:
3331

3432
python setup.py test --ro-functional
3533

36-
# Read/Write Functional Tests.
34+
## Read/Write Functional Tests.
3735

3836
Before running rw-functional tests, make sure you have logged into bugzilla
3937
using. These currently run against the test bugzilla instance at
@@ -42,25 +40,26 @@ partner-bugzilla.redhat.com, and requires a valid login there:
4240
bugzilla-cli --bugzilla=partner-bugzilla.redhat.com --user=$USER login
4341
python setup.py test --rw-functional
4442

45-
# Testing across python versions
43+
## Testing across python versions
4644
To test all supported python versions, run tox using any of the following.
4745

4846
tox
4947
tox -- --ro-functional
5048
tox -- --rw-functional
5149

5250

53-
3. pylint and pep8
54-
------------------
51+
# pylint and pep8
52+
5553
To test for pylint or pep8 violations, you can run:
54+
5655
python setup.py pylint
5756

5857
Note: This expects that you already have pylint and pep8 (installed when setting
5958
up virtualenv) installed.
6059

6160

62-
4. Patch Submission
63-
-------------------
61+
# Patch Submission
62+
6463
If you are submitting a patch, ensure the following:
6564
[REQ] verify that no new pylint or pep8 violations
6665
[REQ] run basic unit test suite across all python versions as described
@@ -69,11 +68,5 @@ If you are submitting a patch, ensure the following:
6968
Running any of the functional tests is not a requirement for patch submission,
7069
but please give them a go if you are interested.
7170

72-
Submitting a patch is straight forward; you need to submit it to
73-
python-bugzilla@lists.fedorahosted.org using the git-send-email command.
74-
75-
For example, assuming you have configured smtp and is working on a feature branch, the following will submit all commits you have on top of master.
76-
77-
$ git send-email --from <your email id> --to python-bugzilla@lists.fedorahosted.org master
78-
79-
For more information about git-send-email refer to http://git-scm.com/docs/git-send-email
71+
Patches can be submitted via github pull-request, or via the mailing list
72+
at python-bugzilla@lists.fedorahosted.org using 'git send-email'.

‎README‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# python-bugzilla
2+
3+
This package provides two bits:
4+
5+
* 'bugzilla' python module for talking to a [Bugzilla](https://www.bugzilla.org/) instance over XMLRPC
6+
* /usr/bin/bugzilla command line tool for performing actions from the command line: create or edit bugs, various queries, etc.
7+
8+
This was originally written specifically for Red Hat's Bugzilla instance
9+
and is used heavily at Red Hat and in Fedora, but it should still be
10+
generically useful.
11+
12+
For questions about submitting bug reports or patches, see [CONTRIBUTIONS.md](CONTRIBUTIONS.md)
13+
14+
Questions, comments, and discussions should go to our mailing: http://lists.fedorahosted.org/mailman/listinfo/python-bugzilla

‎bin/bugzilla‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -596,9 +596,11 @@ is interrupted by the user (or a login attempt fails), 2 if a
596596
socket error occurs (e.g. TCP connection timeout), and 3 if the server returns
597597
an XML-RPC fault.
598598
.SH BUGS
599-
Please report any bugs to bugzilla.redhat.com
599+
Please report any bugs as github issues at
600600
.br
601-
Product=Fedora component=python-bugzilla or to the mailing list at
601+
https://github.com/python-bugzilla/python-bugzilla
602+
.br
603+
to the mailing list at
602604
.br
603605
https://fedorahosted.org/mailman/listinfo/python-bugzilla
604606
.SH SEE ALSO

‎bugzilla.1‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH bugzilla 1 "May 22, 2015" "version 1.2.1" "User Commands"
1+
.TH bugzilla 1 "September 02, 2015" "version 1.2.1" "User Commands"
22
.SH NAME
33
bugzilla \- command-line interface to Bugzilla over XML-RPC
44
.SH SYNOPSIS
@@ -339,7 +339,6 @@ invoking the command.
339339
Additionally, the --no-cache-credentials option will tell the bugzilla tool to
340340
_not_ save any credentials to ~/.bugzillacookies or ~/.bugzillatoken.
341341

342-
343342
.SH EXAMPLES
344343
.PP
345344
.RS 0
@@ -373,9 +372,11 @@ is interrupted by the user (or a login attempt fails), 2 if a
373372
socket error occurs (e.g. TCP connection timeout), and 3 if the server returns
374373
an XML-RPC fault.
375374
.SH BUGS
376-
Please report any bugs to bugzilla.redhat.com
375+
Please report any bugs as github issues at
376+
.br
377+
https://github.com/python-bugzilla/python-bugzilla
377378
.br
378-
Product=Fedora component=python-bugzilla or to the mailing list at
379+
to the mailing list at
379380
.br
380381
https://fedorahosted.org/mailman/listinfo/python-bugzilla
381382
.SH SEE ALSO

‎python-bugzilla.spec‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Release: 1%{?dist}
1111
Summary: A python library and tool for interacting with Bugzilla
1212

1313
License: GPLv2+
14-
URL: https://fedorahosted.org/python-bugzilla
15-
Source0: https://fedorahosted.org/releases/p/y/%{name}/%{name}-%{version}.tar.gz
14+
URL: https://github.com/python-bugzilla/python-bugzilla
15+
Source0: https://github.com/python-bugzilla/python-bugzilla/archive/v%{version}.tar.gz#/%{name}-%{version}.tar.gz
1616
BuildArch: noarch
1717

1818
BuildRequires: python2-devel

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ def _parse_requirements(fname):
187187
author='Cole Robinson',
188188
author_email='python-bugzilla@lists.fedorahosted.org',
189189
license="GPLv2",
190-
url='https://fedorahosted.org/python-bugzilla/',
190+
url='https://github.com/python-bugzilla/python-bugzilla',
191191
packages = ['bugzilla'],
192192
scripts=['bin/bugzilla'],
193193
data_files=[('share/man/man1', ['bugzilla.1'])],

0 commit comments

Comments
 (0)