Skip to content

Commit

Permalink
Rebrand JIRA -> Jira.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
josephw authored and ssbarnea committed Jun 5, 2020
1 parent 856d624 commit 1ca920e
Show file tree
Hide file tree
Showing 18 changed files with 145 additions and 145 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===================
JIRA Python Library
Jira Python Library
===================

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


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

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.

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


Credits
-------

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

* 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.
* 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.
* JetBrains_ for providing us with free licenses of PyCharm_
* Travis_ for hosting our continuous integration
* Navicat_ for providing us free licenses of their powerful database client GUI tools.

.. _Atlassian: https://www.atlassian.com/
.. _JIRA: https://pycontribs.atlassian.net
.. _Jira: https://pycontribs.atlassian.net
.. _JetBrains: http://www.jetbrains.com
.. _PyCharm: http://www.jetbrains.com/pycharm/
.. _Travis: https://travis-ci.org/
Expand Down
10 changes: 5 additions & 5 deletions docs/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Advanced
Resource Objects and Properties
===============================

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

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

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

The JIRA client's methods document whether they will return a *Resource* or a properties object.
The Jira client's methods document whether they will return a *Resource* or a properties object.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# JIRA Python Client documentation build configuration file, created by
# Jira Python Client documentation build configuration file, created by
# sphinx-quickstart on Thu May 3 17:01:50 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
Expand Down
24 changes: 12 additions & 12 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Here's a quick usage example:

.. literalinclude:: ../examples/basic_use.py

Another example shows how to authenticate with your JIRA username and password:
Another example shows how to authenticate with your Jira username and password:

.. literalinclude:: ../examples/basic_auth.py

Expand All @@ -23,24 +23,24 @@ Quickstart
Initialization
--------------

Everything goes through the JIRA object, so make one::
Everything goes through the ``JIRA`` object, so make one::

from jira import JIRA

jira = JIRA()

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

You can manually set the JIRA server to use::
You can manually set the Jira server to use::

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

Authentication
--------------

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

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.

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

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

Kerberos
^^^^^^^^
Expand All @@ -106,7 +106,7 @@ To pass additional options to Kerberos auth use dict ``kerberos_options``, e.g.:
Issues
------

Issues are objects. You get hold of them through the JIRA object::
Issues are objects. You get hold of them through the ``JIRA`` object::

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

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

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

.. note::
Expand Down Expand Up @@ -241,7 +241,7 @@ to quickly find the issues you want::
Comments
--------

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

comments_a = issue.fields.comment.comments
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
contain the root `toctree` directive.
Python JIRA
Python Jira
###########
Python library to work with JIRA APIs
Python library to work with Jira APIs

.. toctree::
:numbered:
Expand All @@ -19,7 +19,7 @@ Python library to work with JIRA APIs
api

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

Documentation is also available in
`Dash
Expand Down
8 changes: 4 additions & 4 deletions docs/jirashell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ it, and bang your elbows -- trial and error. A REST design is especially well-su
Run it from the command line::

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

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

In [1]:

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

Try getting an issue::
Expand Down
4 changes: 2 additions & 2 deletions examples/basic_auth.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# This script shows how to connect to a JIRA instance with a
# This script shows how to connect to a Jira instance with a
# username and password over HTTP BASIC authentication.

from collections import Counter
from jira import JIRA

# By default, the client will connect to a JIRA instance started from the Atlassian Plugin SDK.
# By default, the client will connect to a Jira instance started from the Atlassian Plugin SDK.
# See
# https://developer.atlassian.com/display/DOCS/Installing+the+Atlassian+Plugin+SDK
# for details.
Expand Down
2 changes: 1 addition & 1 deletion examples/basic_use.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from jira import JIRA
import re

# By default, the client will connect to a JIRA instance started from the Atlassian Plugin SDK
# By default, the client will connect to a Jira instance started from the Atlassian Plugin SDK
# (see https://developer.atlassian.com/display/DOCS/Installing+the+Atlassian+Plugin+SDK for details).
# Override this with the options parameter.
options = {"server": "https://jira.atlassian.com"}
Expand Down
4 changes: 2 additions & 2 deletions examples/cookie_auth.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# This script shows how to connect to a JIRA instance with a
# This script shows how to connect to a Jira instance with a
# username and password over HTTP BASIC authentication.

from collections import Counter
from jira import JIRA

# By default, the client will connect to a JIRA instance started from the Atlassian Plugin SDK.
# By default, the client will connect to a Jira instance started from the Atlassian Plugin SDK.
# See
# https://developer.atlassian.com/display/DOCS/Installing+the+Atlassian+Plugin+SDK
# for details.
Expand Down
4 changes: 2 additions & 2 deletions examples/greenhopper.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
# against jira.atlassian.com.
from jira.client import GreenHopper

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

Expand Down
Loading

0 comments on commit 1ca920e

Please sign in to comment.