Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
redtoad committed Jan 10, 2017
0 parents commit 5550be0
Show file tree
Hide file tree
Showing 8 changed files with 236 additions and 0 deletions.
94 changes: 94 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@

examples/python-issues.json

### Python template
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# IPython Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# dotenv
.env

# virtualenv
venv/
ENV/

# Spyder project settings
.spyderproject

# Rope project settings
.ropeproject

1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
jira-cache is written and maintained by Sebastian Rahlf
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2016 Sebastian Rahlf

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
62 changes: 62 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
==========
jira-cache
==========

Dump Jira issues to file and reload them without connection to the original server.

Quickstart
----------

Dump issues::

from jira import JIRA
from jira_cache import CachedIssues

jira = JIRA('https://jira.atlassian.com/')
result = jira.search_issues('project=JRA and text ~ "Python"')
cached = CachedIssues(result)
cached.dump(open('python-issues.json', 'w'))

Loading from file::

from jira import JIRA
from jira_cache import CachedIssues

result = CachedIssues.load(open('python-issues.json'))

Installation
------------

Simply run ::

pip install jira-history

Contributing
------------

Please do! I would love for this to be developed further by anyone who is interested. Wherever possible, please
provide unit tests for your work (yes, this is very much a 'do as I say, not as I do' kind of moment).
Don't forget to add your name to AUTHORS.

License
-------

Copyright (c) 2016 Sebastian Rahlf

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
17 changes: 17 additions & 0 deletions examples/dump-issues.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

import sys
sys.path.insert(0, '..')

from jira import JIRA
from jira_cache import CachedIssues

print('Connecting to https://jira.atlassian.com...')
jira = JIRA('https://jira.atlassian.com/')
result = jira.search_issues('project=JRA and text ~ "Python"', expand='changelog')

print('Caching %i issues...' % len(result))
cached = CachedIssues(result)
cached.dump(open('python-issues.json', 'w'))

print('Loading issues from dump...')
print(CachedIssues.load(open('python-issues.json')))
2 changes: 2 additions & 0 deletions jira_cache/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

from .cache import CachedIssues
18 changes: 18 additions & 0 deletions jira_cache/cache.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import json

from jira.resources import cls_for_resource


class CachedIssues(list):

def __init__(self, issues, jql=None):
super().__init__(issues)

def dump(self, fp):
return json.dump([issue.raw for issue in iter(self)], fp)

@staticmethod
def load(fp):
data = json.load(fp)
issues = [cls_for_resource(issue['self'])(None, None, issue) for issue in data]
return CachedIssues(issues)
21 changes: 21 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
from distutils.core import setup
import os


def read(path):
root = os.path.dirname(os.path.abspath(__file__))
return open(os.path.join(root, path)).read()


setup(
name='jira-cache',
description='Dump Jira issues to file and reload them without connection to the original server.',
long_description=read('README.rst'),
url='https://github.com/redtoad/jira-cache',
version='0.8',
author='Sebastian Rahlf',
author_email='[email protected]',
packages=['jira_cache'],
requires=['jira'],
license='MIT'
)

0 comments on commit 5550be0

Please sign in to comment.