Skip to content

Commit 1ca920e

Browse files
josephwssbarnea
authored andcommitted
Rebrand JIRA -> Jira.
Back in 2017, Atlassian rebranded 'JIRA' to 'Jira': https://www.atlassian.com/blog/announcements/our-bold-new-brand Adopt the new version in all commments and descriptions, without any changes to API. Where it's the API object being talked about, mark up as ``JIRA`` to clarify.
1 parent 856d624 commit 1ca920e

18 files changed

+145
-145
lines changed

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
===================
2-
JIRA Python Library
2+
Jira Python Library
33
===================
44

55
.. image:: https://img.shields.io/pypi/v/jira.svg
@@ -40,7 +40,7 @@ JIRA Python Library
4040
:alt: Requirements Status
4141

4242

43-
This library eases the use of the JIRA REST API from Python and it has been used in production for years.
43+
This library eases the use of the Jira REST API from Python and it has been used in production for years.
4444

4545
As this is an open-source project that is community maintained, do not be surprised if some bugs or features are not implemented quickly enough. You are always welcomed to use BountySource_ to motivate others to help.
4646

@@ -102,7 +102,7 @@ Setup
102102
* Fork_ repo
103103
* Keep it sync_'ed while you are developing
104104
* Install pyenv_
105-
* Install `Atlassian JIRA Server`_ for testing
105+
* Install `Atlassian Jira Server`_ for testing
106106
- make install-sdk
107107
* pip install jira[test]
108108
* Start up Jira Server
@@ -113,21 +113,21 @@ Setup
113113
.. _Fork: https://help.github.com/articles/fork-a-repo/
114114
.. _sync: https://help.github.com/articles/syncing-a-fork/
115115
.. _pyenv: https://amaral.northwestern.edu/resources/guides/pyenv-tutorial
116-
.. _`Atlassian JIRA Server`: https://www.atlassian.com/software/jira/download
116+
.. _`Atlassian Jira Server`: https://www.atlassian.com/software/jira/download
117117

118118

119119
Credits
120120
-------
121121

122122
In addition to all the contributors we would like to thank to these companies:
123123

124-
* Atlassian_ for developing such a powerful issue tracker and for providing a free on-demand JIRA_ instance that we can use for continuous integration testing.
124+
* Atlassian_ for developing such a powerful issue tracker and for providing a free on-demand Jira_ instance that we can use for continuous integration testing.
125125
* JetBrains_ for providing us with free licenses of PyCharm_
126126
* Travis_ for hosting our continuous integration
127127
* Navicat_ for providing us free licenses of their powerful database client GUI tools.
128128

129129
.. _Atlassian: https://www.atlassian.com/
130-
.. _JIRA: https://pycontribs.atlassian.net
130+
.. _Jira: https://pycontribs.atlassian.net
131131
.. _JetBrains: http://www.jetbrains.com
132132
.. _PyCharm: http://www.jetbrains.com/pycharm/
133133
.. _Travis: https://travis-ci.org/

docs/advanced.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Advanced
44
Resource Objects and Properties
55
===============================
66

7-
The library distinguishes between two kinds of data in the JIRA REST API: *resources* and *properties*.
7+
The library distinguishes between two kinds of data in the Jira REST API: *resources* and *properties*.
88

99
A *resource* is a REST entity that represents the current state of something that the server owns; for example,
10-
the issue called "ABC-123" is a concept managed by JIRA which can be viewed as a resource obtainable at the URL
10+
the issue called "ABC-123" is a concept managed by Jira which can be viewed as a resource obtainable at the URL
1111
*http://jira-server/rest/api/latest/issue/ABC-123*. All resources have a *self link*: a root-level property called *self*
1212
which contains the URL the resource originated from. In jira-python, resources are instances of the *Resource* object
1313
(or one of its subclasses) and can only be obtained from the server using the ``find()`` method. Resources may be
@@ -20,10 +20,10 @@ connected to other resources: the issue *Resource* is connected to a user *Resou
2020
user *Resource* object. Whenever a resource contains other resources, the client will attempt to convert them
2121
to the proper subclass of *Resource*.
2222

23-
A *properties object* is a collection of values returned by JIRA in response to some query from the REST API. Their
23+
A *properties object* is a collection of values returned by Jira in response to some query from the REST API. Their
2424
structure is freeform and modeled as a Python dict. Client methods return this structure for calls that do not
2525
produce resources. For example, the properties returned from the URL *http://jira-server/rest/api/latest/issue/createmeta*
2626
are designed to inform users what fields (and what values for those fields) are required to successfully create
27-
issues in the server's projects. Since these properties are determined by JIRA's configuration, they are not resources.
27+
issues in the server's projects. Since these properties are determined by Jira's configuration, they are not resources.
2828

29-
The JIRA client's methods document whether they will return a *Resource* or a properties object.
29+
The Jira client's methods document whether they will return a *Resource* or a properties object.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# JIRA Python Client documentation build configuration file, created by
3+
# Jira Python Client documentation build configuration file, created by
44
# sphinx-quickstart on Thu May 3 17:01:50 2012.
55
#
66
# This file is execfile()d with the current directory set to its containing dir.

docs/examples.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here's a quick usage example:
88

99
.. literalinclude:: ../examples/basic_use.py
1010

11-
Another example shows how to authenticate with your JIRA username and password:
11+
Another example shows how to authenticate with your Jira username and password:
1212

1313
.. literalinclude:: ../examples/basic_auth.py
1414

@@ -23,24 +23,24 @@ Quickstart
2323
Initialization
2424
--------------
2525

26-
Everything goes through the JIRA object, so make one::
26+
Everything goes through the ``JIRA`` object, so make one::
2727

2828
from jira import JIRA
2929

3030
jira = JIRA()
3131

32-
This connects to a JIRA started on your local machine at http://localhost:2990/jira, which not coincidentally is the
33-
default address for a JIRA instance started from the Atlassian Plugin SDK.
32+
This connects to a Jira started on your local machine at http://localhost:2990/jira, which not coincidentally is the
33+
default address for a Jira instance started from the Atlassian Plugin SDK.
3434

35-
You can manually set the JIRA server to use::
35+
You can manually set the Jira server to use::
3636

3737
jac = JIRA('https://jira.atlassian.com')
3838

3939
Authentication
4040
--------------
4141

4242
At initialization time, jira-python can optionally create an HTTP BASIC or use OAuth 1.0a access tokens for user
43-
authentication. These sessions will apply to all subsequent calls to the JIRA object.
43+
authentication. These sessions will apply to all subsequent calls to the ``JIRA`` object.
4444

4545
The library is able to load the credentials from inside the ~/.netrc file, so put them there instead of keeping them in your source code.
4646

@@ -84,11 +84,11 @@ Pass a dict of OAuth properties to the ``oauth`` constructor argument::
8484
interactive use, ``jirashell`` can perform the dance with you if you don't already have valid tokens.
8585
8686
* The access token and token secret uniquely identify the user.
87-
* The consumer key must match the OAuth provider configured on the JIRA server.
88-
* The key cert data must be the private key that matches the public key configured on the JIRA server's OAuth provider.
87+
* The consumer key must match the OAuth provider configured on the Jira server.
88+
* The key cert data must be the private key that matches the public key configured on the Jira server's OAuth provider.
8989

9090
See https://confluence.atlassian.com/display/JIRA/Configuring+OAuth+Authentication+for+an+Application+Link for details
91-
on configuring an OAuth provider for JIRA.
91+
on configuring an OAuth provider for Jira.
9292

9393
Kerberos
9494
^^^^^^^^
@@ -106,7 +106,7 @@ To pass additional options to Kerberos auth use dict ``kerberos_options``, e.g.:
106106
Issues
107107
------
108108

109-
Issues are objects. You get hold of them through the JIRA object::
109+
Issues are objects. You get hold of them through the ``JIRA`` object::
110110

111111
issue = jira.issue('JRA-1330')
112112

@@ -164,7 +164,7 @@ You can even bulk create multiple issues::
164164
issues = jira.create_issues(field_list=issue_list)
165165

166166
.. note::
167-
Project, summary, description and issue type are always required when creating issues. Your JIRA may require
167+
Project, summary, description and issue type are always required when creating issues. Your Jira may require
168168
additional fields for creating issues; see the ``jira.createmeta`` method for getting access to that information.
169169

170170
.. note::
@@ -241,7 +241,7 @@ to quickly find the issues you want::
241241
Comments
242242
--------
243243

244-
Comments, like issues, are objects. Get at issue comments through the parent Issue object or the JIRA object's
244+
Comments, like issues, are objects. Get at issue comments through the parent Issue object or the ``JIRA`` object's
245245
dedicated method::
246246

247247
comments_a = issue.fields.comment.comments

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
contain the root `toctree` directive.
55
66
7-
Python JIRA
7+
Python Jira
88
###########
9-
Python library to work with JIRA APIs
9+
Python library to work with Jira APIs
1010

1111
.. toctree::
1212
:numbered:
@@ -19,7 +19,7 @@ Python library to work with JIRA APIs
1919
api
2020

2121
This documents the ``jira`` python package (version |release|), a Python library designed to ease the use of the
22-
JIRA REST API. Some basic support for the GreenHopper REST API also exists.
22+
Jira REST API. Some basic support for the GreenHopper REST API also exists.
2323

2424
Documentation is also available in
2525
`Dash

docs/jirashell.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ it, and bang your elbows -- trial and error. A REST design is especially well-su
88
Run it from the command line::
99

1010
$ jirashell -s http://jira.atlassian.com
11-
<JIRA Shell (http://jira.atlassian.com)>
11+
<Jira Shell (http://jira.atlassian.com)>
1212

13-
*** JIRA shell active; client is in 'jira'. Press Ctrl-D to exit.
13+
*** Jira shell active; client is in 'jira'. Press Ctrl-D to exit.
1414

1515
In [1]:
1616

17-
This is a specialized Python interpreter (built on IPython) that lets you explore JIRA as a service. Any legal
18-
Python code is acceptable input. The shell builds a JIRA client object for you (based on the launch parameters) and
17+
This is a specialized Python interpreter (built on IPython) that lets you explore Jira as a service. Any legal
18+
Python code is acceptable input. The shell builds a ``JIRA`` client object for you (based on the launch parameters) and
1919
stores it in the ``jira`` object.
2020

2121
Try getting an issue::

examples/basic_auth.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# This script shows how to connect to a JIRA instance with a
1+
# This script shows how to connect to a Jira instance with a
22
# username and password over HTTP BASIC authentication.
33

44
from collections import Counter
55
from jira import JIRA
66

7-
# By default, the client will connect to a JIRA instance started from the Atlassian Plugin SDK.
7+
# By default, the client will connect to a Jira instance started from the Atlassian Plugin SDK.
88
# See
99
# https://developer.atlassian.com/display/DOCS/Installing+the+Atlassian+Plugin+SDK
1010
# for details.

examples/basic_use.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from jira import JIRA
44
import re
55

6-
# By default, the client will connect to a JIRA instance started from the Atlassian Plugin SDK
6+
# By default, the client will connect to a Jira instance started from the Atlassian Plugin SDK
77
# (see https://developer.atlassian.com/display/DOCS/Installing+the+Atlassian+Plugin+SDK for details).
88
# Override this with the options parameter.
99
options = {"server": "https://jira.atlassian.com"}

examples/cookie_auth.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# This script shows how to connect to a JIRA instance with a
1+
# This script shows how to connect to a Jira instance with a
22
# username and password over HTTP BASIC authentication.
33

44
from collections import Counter
55
from jira import JIRA
66

7-
# By default, the client will connect to a JIRA instance started from the Atlassian Plugin SDK.
7+
# By default, the client will connect to a Jira instance started from the Atlassian Plugin SDK.
88
# See
99
# https://developer.atlassian.com/display/DOCS/Installing+the+Atlassian+Plugin+SDK
1010
# for details.

examples/greenhopper.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
# against jira.atlassian.com.
33
from jira.client import GreenHopper
44

5-
# By default, the client will connect to a JIRA instance started from the Atlassian Plugin SDK
5+
# By default, the client will connect to a Jira instance started from the Atlassian Plugin SDK
66
# (see https://developer.atlassian.com/display/DOCS/Installing+the+Atlassian+Plugin+SDK for details).
77
# Override this with the options parameter.
8-
# GreenHopper is a plugin in a JIRA instance
8+
# GreenHopper is a plugin in a Jira instance
99
options = {"server": "https://jira.atlassian.com"}
1010
gh = GreenHopper(options)
1111

0 commit comments

Comments
 (0)