Repository: mschwager/gitem
Branch: master
Commit: d40a1c9ba272
Files: 25
Total size: 96.4 KB
Directory structure:
gitextract_or3k8zjn/
├── .coveragerc
├── .flake8
├── .github/
│ └── workflows/
│ └── main.yml
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── lib/
│ └── gitem/
│ ├── __init__.py
│ ├── __main__.py
│ ├── analytics.py
│ ├── api.py
│ └── output/
│ ├── __init__.py
│ ├── base.py
│ ├── json.py
│ └── stdout.py
├── requirements-dev.txt
├── requirements.txt
├── setup.cfg
├── setup.py
└── tests/
├── mocked_api_results.py
├── test_analytics.py
├── test_api.py
└── test_output/
├── test_json.py
└── test_stdout.py
================================================
FILE CONTENTS
================================================
================================================
FILE: .coveragerc
================================================
[report]
include = lib/*
================================================
FILE: .flake8
================================================
[flake8]
ignore = E501,W503
include = lib,tests
exclude = setup.py
================================================
FILE: .github/workflows/main.yml
================================================
name: Dlint
on: [push, pull_request]
jobs:
dlint:
runs-on: ubuntu-latest
name: Dlint
steps:
- uses: actions/checkout@master
- uses: dlint-py/dlint-action@master
================================================
FILE: .gitignore
================================================
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
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
# Vim swap files
*.sw[op]
================================================
FILE: .travis.yml
================================================
dist: xenial
language: python
cache: pip
python:
- 2.7
- 3.5
- 3.6
- 3.7
- 3.8-dev
before_install:
- if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install mock; fi
install:
- pip install -r requirements.txt
- pip install -r requirements-dev.txt
- pip install -e .
script:
- flake8
- pytest --cov
after_success:
- coveralls
================================================
FILE: CHANGELOG.md
================================================
# Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
This project adheres to [CHANGELOG](http://keepachangelog.com/).
## [Unreleased]
## [0.9.2] - 2018-11-22
### Fixed
- Python package version classifiers
## [0.9.1] - 2018-11-22
### Fixed
- Build when using Python 3.8
## [0.9.0] - 2019-11-22
### Added
- Python 3.8 support
### Fixed
- Specifying incorrect contributor information ([#10](https://github.com/mschwager/gitem/issues/10))
### Removed
- Official Python 3.4 support, it's EOL
## [0.8.1] - 2018-11-06
### Security
- Updated requests dependency per CVE-2018-18074
## [0.8.0] - 2018-10-12
### Added
- The --output flag which supports JSON output
## [0.7.1] - 2018-07-12
### Fixed
- Included README in package long_description
## [0.7.0] - 2018-07-12
### Added
- Python 3.7 support
- Clone URL information to repository queries
### Fixed
- Avoid using builtin variable names
## [0.6.1] - 2018-02-06
### Fixed
- Incorrect variable name used
### Removed
- Python 3.3 support, it's EOL
## [0.6.0] - 2017-06-15
### Added
- Python 3.6 support
## [0.5.1] - 2016-11-29
### Fixed
- Added friendlier error message when resources not found
## [0.5.0] - 2016-10-02
### Added
- Initial release of Gitem
================================================
FILE: LICENSE
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
{project} Copyright (C) {year} {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
================================================
FILE: README.md
================================================
# Gitem
[](https://travis-ci.org/mschwager/gitem)
[](https://coveralls.io/github/mschwager/gitem?branch=master)
[](https://github.com/dlint-py/dlint-action)
[](https://img.shields.io/pypi/pyversions/gitem.svg)
[](https://img.shields.io/pypi/v/gitem.svg)
`Gitem` is a tool for performing Github organizational reconnaissance.
This could include information for:
* [OSINT](https://en.wikipedia.org/wiki/Open-source_intelligence)
* Spearphishing
* Recruitment
* Competitive analysis
* OPSEC self-assessment
# Installing
```
$ pip install gitem
$ gitem -h
```
OR
```
$ git clone https://github.com/mschwager/gitem.git
$ cd gitem
$ pip install --requirement requirements.txt
$ PYTHONPATH=lib/ python -m gitem -h
```
# Using
`Gitem` can be used to collect information at various levels of granularity from Github.
*Note, most commands will shorten output by default, specify `--verbose` to change this behavior*
For example, let's grab some information about Facebook:
```
$ gitem organization facebook
Website: https://code.facebook.com/projects/
Username: facebook
Description: We work hard to contribute our work back to the web, mobile, big data, & infrastructure communities. NB: members must have two-factor auth.
Created: 2009-04-02T03:35:22Z
Github URL: https://github.com/facebook
Last Updated: 2016-09-21T15:36:43Z
# of Public Repositories: 173
Location: Menlo Park, California
Organization Name: Facebook
Email Address:
Public Members:
...
Public Repositories:
Repository Name: react
Watchers: 50773
Description: A declarative, efficient, and flexible JavaScript library for building user interfaces.
Created: 2013-05-24T16:15:54Z
Github URL: https://github.com/facebook/react
Last Updated: 2016-10-01T15:09:54Z
Stars: 50773
Forks: 8855
Last Pushed: 2016-10-01T14:27:58Z
Repository Name: react-native
Watchers: 38364
Description: A framework for building native apps with React.
Created: 2015-01-09T18:10:16Z
Github URL: https://github.com/facebook/react-native
Last Updated: 2016-10-01T14:37:29Z
Stars: 38364
Forks: 8531
Last Pushed: 2016-10-01T14:15:31Z
Repository Name: pop
Watchers: 16481
Description: An extensible iOS and OS X animation library, useful for physics-based interactions.
Created: 2014-03-30T22:29:12Z
Github URL: https://github.com/facebook/pop
Last Updated: 2016-10-01T14:12:35Z
Stars: 16481
Forks: 2630
Last Pushed: 2016-08-23T17:23:10Z
...
```
From here we can drill down into a certain repository:
```
$ gitem repository facebook react
Repository Name: react
Watchers: 50773
Description: A declarative, efficient, and flexible JavaScript library for building user interfaces.
Last Pushed: 2016-10-01T14:27:58Z
Created: 2013-05-24T16:15:54Z
Github URL: https://github.com/facebook/react
Last Updated: 2016-10-01T15:09:54Z
Language: JavaScript
Stars: 50773
Forks: 8855
Homepage: https://facebook.github.io/react/
Contributors:
Username: zpao
Contributions: 1755
Username: spicyj
Contributions: 1108
Username: jimfb
Contributions: 456
Username: sebmarkbage
Contributions: 378
Username: petehunt
Contributions: 332
...
```
And finally, we can analyze specific users:
*Note, this task is easily parallelizable, so we can specify `--processes 4`*
```
$ gitem --processes 4 user <redacted>
Username: <redacted>
Updated: 2016-09-29T02:06:31Z
Name: <redacted>
Created: 2008-04-25T04:38:22Z
Github URL: <redacted>
Company: Facebook
Blog: <redacted>
Location: <redacted>
Email Address: <redacted>
Organizations:
Organization: facebook
Organization: reactjs
Organization: relayjs
Repositories:
<redacted>
...
Emails:
<redacted>
...
```
# Developing
First, install development packages:
```
$ pip install -r requirements-dev.txt
$ pip install -e .
```
## Testing
```
$ pytest
```
## Linting
```
$ flake8
```
## Coverage
```
$ pytest --cov
```
================================================
FILE: lib/gitem/__init__.py
================================================
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
from . import api
from . import analytics
from . import output
__name__ = 'gitem'
__version__ = '0.9.2'
__all__ = [
'api',
'analytics',
'output',
]
================================================
FILE: lib/gitem/__main__.py
================================================
#!/usr/bin/env python
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
import argparse
import collections
import functools
import multiprocessing
from . import api
from . import analytics
from . import output
CONCISE_COUNT = 5
def organization(ghapi, outputter, *args, **kwargs):
organization = kwargs['name']
verbose = kwargs['verbose']
organization_info = analytics.get_organization_information(
ghapi,
organization
)
outputter.output(organization_info)
organization_members = analytics.get_organization_members(
ghapi,
organization
)
def member_administrator(member):
return member['Site Administrator']
members = sorted(
organization_members,
key=member_administrator,
reverse=True
)
member_count = len(members) if verbose else CONCISE_COUNT
outputter.output(collections.OrderedDict([
("Public Members", collections.OrderedDict([
(member["Username"], collections.OrderedDict([
(human_readable_name, api_info)
for human_readable_name, api_info in member.items()
]))
for member in members[:member_count]
]))
]))
organization_repositories = analytics.get_organization_repositories(
ghapi,
organization
)
def repository_popularity(repository):
return (
int(repository['Watchers'])
+ int(repository['Stars'])
+ int(repository['Forks'])
)
repositories = sorted(
organization_repositories,
key=repository_popularity,
reverse=True
)
repository_count = len(repositories) if verbose else CONCISE_COUNT
outputter.output(collections.OrderedDict([
("Public Repositories", collections.OrderedDict([
(repository["Repository Name"], collections.OrderedDict([
(human_readable_name, api_info)
for human_readable_name, api_info in repository.items()
]))
for repository in repositories[:repository_count]
]))
]))
def repository(ghapi, outputter, *args, **kwargs):
repository = kwargs['name']
owner = kwargs['owner']
verbose = kwargs['verbose']
repository_info = analytics.get_repository_information(
ghapi,
owner,
repository
)
outputter.output(repository_info)
repository_contributors = analytics.get_repository_contributors(
ghapi,
owner,
repository
)
contributor_count = len(repository_contributors) if verbose else CONCISE_COUNT
outputter.output(collections.OrderedDict([
("Contributors", collections.OrderedDict([
(contributor["Username"], collections.OrderedDict([
(human_readable_name, api_info)
for human_readable_name, api_info in contributor.items()
]))
for contributor in repository_contributors[:contributor_count]
]))
]))
def user(ghapi, outputter, *args, **kwargs):
username = kwargs['name']
verbose = kwargs['verbose']
processes = kwargs['processes']
user_info = analytics.get_user_information(
ghapi,
username
)
outputter.output(user_info)
user_organizations = analytics.get_user_organizations(
ghapi,
username
)
organization_count = len(user_organizations) if verbose else CONCISE_COUNT
outputter.output(collections.OrderedDict([
("Organizations", collections.OrderedDict([
(organization["Organization"], collections.OrderedDict([
(human_readable_name, api_info)
for human_readable_name, api_info in organization.items()
]))
for organization in user_organizations[:organization_count]
]))
]))
user_repositories = analytics.get_user_repositories(
ghapi,
username
)
repository_count = len(user_repositories) if verbose else CONCISE_COUNT
outputter.output(collections.OrderedDict([
("Repositories", collections.OrderedDict([
(repository["Repository Name"], collections.OrderedDict([
(human_readable_name, api_info)
for human_readable_name, api_info in repository.items()
]))
for repository in user_repositories[:repository_count]
]))
]))
user_repository_names = [
repository['Repository Name']
for repository in user_repositories
]
if processes:
pool = multiprocessing.Pool(processes=processes)
partial_email_fn = functools.partial(
analytics.get_repository_commit_emails,
ghapi,
username,
author=username
)
user_repository_emails = pool.map(partial_email_fn, user_repository_names)
else:
user_repository_emails = [
analytics.get_repository_commit_emails(
ghapi,
username,
repository,
author=username
)
for repository in user_repository_names
]
user_emails = functools.reduce(set.union, user_repository_emails, set())
outputter.output(collections.OrderedDict([
("Emails", [
str((name, email))
for name, email in user_emails
]),
]))
def parse_args():
p = argparse.ArgumentParser(description='''
A Github organization reconnaissance tool.
''', formatter_class=argparse.RawTextHelpFormatter)
p.add_argument(
'-o',
'--oauth2-token',
action='store',
help='OAuth2 token for authentcation'
)
p.add_argument(
'-v',
'--verbose',
action='store_true',
help='verbose output'
)
p.add_argument(
'-p',
'--processes',
action='store',
type=int,
help='number of processes (for applicable commands)'
)
p.add_argument(
'-t',
'--output',
action='store',
choices=[
output.Stdout.name,
output.Json.name,
],
default=output.Stdout.name,
help='show results in this format'
)
subparsers = p.add_subparsers(dest='command')
organization = subparsers.add_parser('organization')
organization.add_argument(
'name',
action='store',
help='Github organization name'
)
repository = subparsers.add_parser('repository')
repository.add_argument(
'owner',
action='store',
help='Github repository owner'
)
repository.add_argument(
'name',
action='store',
help='Github repository name'
)
user = subparsers.add_parser('user')
user.add_argument(
'name',
action='store',
help='Github user name'
)
args = p.parse_args()
return args
def main():
args = parse_args()
dispatch = {
"organization": organization,
"repository": repository,
"user": user,
}
ghapi = api.Api(args.oauth2_token)
outputters = {
output.Stdout.name: output.Stdout,
output.Json.name: output.Json,
}
outputter = outputters[args.output]()
try:
dispatch[args.command](ghapi, outputter, **vars(args))
except api.ApiCallException as e:
if e.rate_limiting:
outputter.output({
"Error": (
"Your API requests are being rate-limited. "
+ "Please include an OAuth2 token and read the following:"
)
})
outputter.output({
"Rate Limiting": e.rate_limiting_url
})
elif e.not_found:
outputter.output({
"Error": (
"The requested resource was not found or private. "
+ "Please confirm that it exists."
)
})
else:
# Re-raise original exception
raise
if __name__ == "__main__":
main()
================================================
FILE: lib/gitem/analytics.py
================================================
#!/usr/bin/env python
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
import collections
from . import api
def get_organization_information(ghapi, organization):
organization_info, _ = ghapi.get_public_organization(
organization
)
api_name_to_human_readable_name = [
('name', 'Organization Name'),
('description', 'Description'),
('blog', 'Website'),
('html_url', 'Github URL'),
('created_at', 'Created'),
('updated_at', 'Last Updated'),
('email', 'Email Address'),
('location', 'Location'),
('login', 'Username'),
('public_repos', '# of Public Repositories'),
]
human_readable_name_to_api_info = collections.OrderedDict([
(human_readable_name, organization_info[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
return human_readable_name_to_api_info
def get_organization_repositories(ghapi, organization):
paged_organization_repositories = ghapi.get_organizations_public_repositories(
organization
)
api_name_to_human_readable_name = [
('name', 'Repository Name'),
('description', 'Description'),
('html_url', 'Github URL'),
('clone_url', 'Clone URL'),
('watchers_count', 'Watchers'),
('stargazers_count', 'Stars'),
('forks_count', 'Forks'),
('created_at', 'Created'),
('updated_at', 'Last Updated'),
('pushed_at', 'Last Pushed'),
]
human_readable_name_to_api_info = [
collections.OrderedDict([
(human_readable_name, organization_repository[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
for organization_repositories, _ in paged_organization_repositories
for organization_repository in organization_repositories
]
return human_readable_name_to_api_info
def get_organization_members(ghapi, organization):
paged_organization_members = ghapi.get_organizations_public_members(
organization
)
api_name_to_human_readable_name = [
('login', 'Username'),
('site_admin', 'Site Administrator'),
('html_url', 'Github URL'),
]
human_readable_name_to_api_info = [
collections.OrderedDict([
(human_readable_name, organization_member[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
for organization_members, _ in paged_organization_members
for organization_member in organization_members
]
return human_readable_name_to_api_info
def get_repository_information(ghapi, owner, repository):
repository_info, _ = ghapi.get_public_repository(
owner,
repository
)
api_name_to_human_readable_name = [
('name', 'Repository Name'),
('description', 'Description'),
('homepage', 'Homepage'),
('html_url', 'Github URL'),
('clone_url', 'Clone URL'),
('created_at', 'Created'),
('updated_at', 'Last Updated'),
('pushed_at', 'Last Pushed'),
('language', 'Language'),
('forks_count', 'Forks'),
('stargazers_count', 'Stars'),
('watchers_count', 'Watchers'),
]
human_readable_name_to_api_info = collections.OrderedDict([
(human_readable_name, repository_info[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
return human_readable_name_to_api_info
def get_repository_contributors(ghapi, owner, repository):
paged_repository_contributors = ghapi.get_repository_contributors(
owner,
repository
)
api_name_to_human_readable_name = [
('login', 'Username'),
('contributions', 'Contributions'),
]
human_readable_name_to_api_info = [
collections.OrderedDict([
(human_readable_name, repository_contributor[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
for repository_contributors, _ in paged_repository_contributors
for repository_contributor in repository_contributors
]
return human_readable_name_to_api_info
def get_user_information(ghapi, username):
user_info, _ = ghapi.get_user(
username
)
api_name_to_human_readable_name = [
('login', 'Username'),
('html_url', 'Github URL'),
('name', 'Name'),
('company', 'Company'),
('blog', 'Blog'),
('location', 'Location'),
('email', 'Email Address'),
('created_at', 'Created'),
('updated_at', 'Updated'),
]
human_readable_name_to_api_info = collections.OrderedDict([
(human_readable_name, user_info[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
return human_readable_name_to_api_info
def get_user_organizations(ghapi, username):
paged_user_organizations = ghapi.get_users_public_organizations(
username
)
api_name_to_human_readable_name = [
('login', 'Organization'),
]
human_readable_name_to_api_info = [
collections.OrderedDict([
(human_readable_name, user_organization[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
for user_organizations, _ in paged_user_organizations
for user_organization in user_organizations
]
return human_readable_name_to_api_info
def get_user_repositories(ghapi, username):
# TODO: Change this back to type_='all' and find a good way to grab
# the correct repository owners
paged_user_repositories = ghapi.get_users_public_repositories(
username,
type_='owner',
sort='pushed',
direction='desc',
)
api_name_to_human_readable_name = [
('name', 'Repository Name'),
('description', 'Description'),
('html_url', 'Github URL'),
('clone_url', 'Clone URL'),
]
human_readable_name_to_api_info = [
collections.OrderedDict([
(human_readable_name, user_repository[api_name])
for api_name, human_readable_name in api_name_to_human_readable_name
])
for user_repositories, _ in paged_user_repositories
for user_repository in user_repositories
]
return human_readable_name_to_api_info
def get_repository_commit_emails(ghapi, owner, repository, author=None):
paged_repository_commits = ghapi.get_repository_commits(
owner,
repository,
author=author
)
# https://developer.github.com/v3/git/
def get_commits_or_empty(repository_commits):
try:
for repository_commit in repository_commits:
yield repository_commit
except api.ApiCallException as e:
if e.conflict:
yield ([], None)
else:
# Re-raise original exception
raise
repository_commit_emails = {
(
repository_commit['commit']['author']['name'],
repository_commit['commit']['author']['email'],
)
for repository_commits, _ in get_commits_or_empty(paged_repository_commits)
for repository_commit in repository_commits
}
return repository_commit_emails
================================================
FILE: lib/gitem/api.py
================================================
#!/usr/bin/env python
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
import functools
import json
import requests
class AuthenticationRequiredException(BaseException):
pass
class ApiCallException(BaseException):
rate_limiting_url = 'https://developer.github.com/v3/#rate-limiting'
def __init__(self, code, message):
self.code = code
self.message = message
@property
def bad_request(self):
return self.code == requests.codes.BAD_REQUEST
@property
def unprocessable_entity(self):
return self.code == requests.codes.UNPROCESSABLE_ENTITY
@property
def forbidden(self):
return self.code == requests.codes.FORBIDDEN
@property
def unauthorized(self):
return self.code == requests.codes.UNAUTHORIZED
@property
def conflict(self):
return self.code == requests.codes.CONFLICT
@property
def not_found(self):
return self.code == requests.codes.NOT_FOUND
@property
def rate_limiting(self):
return (
self.forbidden
and self.message.get('documentation_url') == self.rate_limiting_url
)
def __str__(self):
return "{}: {}".format(self.code, json.dumps(self.message))
def oauth2_required(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
if not args or getattr(args[0], "oauth2_token", None) is None:
raise AuthenticationRequiredException("Please include an OAuth2 token.")
return func(*args, **kwargs)
return wrapper
class Api(object):
BASE_URL = "https://api.github.com"
def __init__(self, oauth2_token=None, requester=requests.request):
self.oauth2_token = oauth2_token
self.requester = requester
# https://developer.github.com/v3/media/#request-specific-version
self.headers = {
"Accept": "application/vnd.github.v3+json",
}
def call(self, method, url, params=None):
"""
Make a Github developer API call
"""
if params is None:
params = {}
if self.oauth2_token:
params["access_token"] = self.oauth2_token
response = self.requester(method, url, params=params, headers=self.headers)
if not response.ok:
raise ApiCallException(response.status_code, response.json())
return response
def json_call(self, method, endpoint, params=None):
"""
Return JSON data from a Github developer API call
"""
if params is None:
params = {}
url = self.BASE_URL + endpoint
response = self.call(method, url, params)
return (response.json(), response.status_code)
def paginated_json_call(self, method, endpoint, params=None):
"""
Return paginated JSON data from a Github developer API call
"""
if params is None:
params = {}
url = self.BASE_URL + endpoint
next_link = True
while next_link:
try:
response = self.call(method, url, params)
except StopIteration:
# Handle PEP 479
return
yield (response.json(), response.status_code)
next_link = response.links.get("next", {})
url = next_link.get("url")
def get_user(self, username):
"""
Return user information associated with a given username
https://developer.github.com/v3/users/#get-a-single-user
"""
method = "GET"
endpoint = "/users/{}".format(username)
params = {}
result = self.json_call(method, endpoint, params)
return result
@oauth2_required
def get_users_organizations(self):
"""
Return organizations associated with an OAuth2 authenticated user
https://developer.github.com/v3/orgs/#list-your-organizations
"""
method = "GET"
endpoint = "/user/orgs"
params = {}
result = self.json_call(method, endpoint, params)
return result
def get_users_public_organizations(self, username):
"""
Return public organizations associated with a user
https://developer.github.com/v3/orgs/#list-user-organizations
"""
method = "GET"
endpoint = "/users/{}/orgs".format(username)
params = {}
result = self.paginated_json_call(method, endpoint, params)
return result
def get_users_public_repositories(self, username, type_=None, sort=None, direction=None):
"""
Return public repositories associated with a given user
https://developer.github.com/v3/repos/#list-user-repositories
"""
type_values = ["all", "owner", "member"]
if type_ not in type_values and type_ is not None:
raise ValueError("type must be one of {}".format(type_values))
sort_values = ["created", "updated", "pushed", "full_name"]
if sort not in sort_values and sort is not None:
raise ValueError("sort must be one of {}".format(sort_values))
direction_values = ["asc", "desc"]
if direction not in direction_values and direction is not None:
raise ValueError("direction must be one of {}".format(direction_values))
method = "GET"
endpoint = "/users/{}/repos".format(username)
params = {}
if type_:
params["type"] = type_
if sort:
params["sort"] = sort
if direction:
params["direction"] = direction
result = self.paginated_json_call(method, endpoint, params)
return result
def get_public_organization(self, organization):
"""
Return public information associated with an organization
https://developer.github.com/v3/orgs/#get-an-organization
"""
method = "GET"
endpoint = "/orgs/{}".format(organization)
params = {}
result = self.json_call(method, endpoint, params)
return result
@oauth2_required
def get_organization(self, organization):
"""
Return information associated with an organization, OAuth2
authenticated user must be an owner
https://developer.github.com/v3/orgs/#get-an-organization
"""
return self.get_public_organization(organization)
def get_organizations_public_repositories(self, organization, type_=None):
"""
Return public repositories associated with a given organization
https://developer.github.com/v3/repos/#list-organization-repositories
"""
type_values = ["all", "public", "private", "forks", "sources", "member"]
if type_ not in type_values and type_ is not None:
raise ValueError("type must be one of {}".format(type_values))
method = "GET"
endpoint = "/orgs/{}/repos".format(organization)
params = {}
if type_:
params["type"] = type_
result = self.paginated_json_call(method, endpoint, params)
return result
def get_organizations_public_members(self, organization):
"""
Return public members associated with a given organization
https://developer.github.com/v3/orgs/members/
"""
method = "GET"
endpoint = "/orgs/{}/public_members".format(organization)
params = {}
result = self.paginated_json_call(method, endpoint, params)
return result
def get_public_repository(self, owner, repository):
"""
Return public information associated with a repository
https://developer.github.com/v3/repos/#get
"""
method = "GET"
endpoint = "/repos/{}/{}".format(owner, repository)
params = {}
result = self.json_call(method, endpoint, params)
return result
def get_repository_contributors(self, owner, repository, anon=None):
"""
Return contributor information associated with a given repository
https://developer.github.com/v3/repos/#list-contributors
"""
anon_values = [1, "true"]
if anon not in anon_values and anon is not None:
raise ValueError("anon must be one of {}".format(anon_values))
method = "GET"
endpoint = "/repos/{}/{}/contributors".format(owner, repository)
params = {}
if anon:
params["anon"] = anon
result = self.paginated_json_call(method, endpoint, params)
return result
def get_repository_commits(self, owner, repository, sha=None, path=None,
author=None, since=None, until=None):
"""
Return commit information associated with a given repository
https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
"""
method = "GET"
endpoint = "/repos/{}/{}/commits".format(owner, repository)
params = {}
if sha:
params["sha"] = sha
if path:
params["path"] = path
if author:
params["author"] = author
if since:
params["since"] = since
if until:
params["until"] = until
result = self.paginated_json_call(method, endpoint, params)
return result
================================================
FILE: lib/gitem/output/__init__.py
================================================
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
from .stdout import Stdout
from .json import Json
__all__ = [
'Stdout',
'Json',
]
================================================
FILE: lib/gitem/output/base.py
================================================
#!/usr/bin/env python
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
import abc
import sys
if sys.version_info >= (3, 4):
ABC = abc.ABC
else:
ABC = abc.ABCMeta(str('ABC'), (), {})
class Base(ABC):
name = "base"
def __init__(self, file_=sys.stdout):
self.file = file_
@abc.abstractmethod
def output(self):
pass
================================================
FILE: lib/gitem/output/json.py
================================================
#!/usr/bin/env python
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
import json
from . import base
class Json(base.Base):
name = "json"
def output(self, data):
output = json.dumps(data, separators=(",", ":"))
print(output, file=self.file)
================================================
FILE: lib/gitem/output/stdout.py
================================================
#!/usr/bin/env python
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
from . import base
class Stdout(base.Base):
name = "stdout"
depth_increment = 2
def __init__(self, *args, **kwargs):
self.first_recurse = True
super(Stdout, self).__init__(*args, **kwargs)
def output_helper(self, data, depth):
for i, (key, value) in enumerate(data.items()):
if isinstance(value, dict):
if depth == 0 and i == 0 and self.first_recurse:
# If we're on the very first dict then don't include an
# awkward newline before we've printed anything else
self.first_recurse = False
else:
print("", file=self.file)
output = "{}:".format(key)
print(" " * depth + output, file=self.file)
self.output_helper(value, depth + self.depth_increment)
elif isinstance(value, list):
output = "{}:".format(key)
print(" " * depth + output, file=self.file)
for l in value:
print(" " * (depth + self.depth_increment) + l, file=self.file)
else:
if value == "":
output = "{}:".format(key)
else:
output = "{}: {}".format(key, value)
print(" " * depth + output, file=self.file)
def output(self, data):
self.output_helper(data, 0)
================================================
FILE: requirements-dev.txt
================================================
pytest==4.6.5
pytest-cov==2.8.1
flake8==3.7.9
coveralls==1.8.2
================================================
FILE: requirements.txt
================================================
requests==2.20.0
================================================
FILE: setup.cfg
================================================
[bdist_wheel]
universal = 1
================================================
FILE: setup.py
================================================
from setuptools import (
find_packages,
setup,
)
import os
import sys
PACKAGE_DIRECTORY = 'lib'
sys.path.append(PACKAGE_DIRECTORY)
import gitem
requirements_filename = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'requirements.txt')
with open(requirements_filename) as fd:
install_requires = [i.strip() for i in fd.readlines()]
requirements_dev_filename = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'requirements-dev.txt')
with open(requirements_dev_filename) as fd:
tests_require = [i.strip() for i in fd.readlines()]
long_description_filename = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'README.md')
with open(long_description_filename) as fd:
long_description = fd.read()
setup(
name=gitem.__name__,
version=gitem.__version__,
description='A Github organization reconnaissance tool.',
long_description=long_description,
long_description_content_type='text/markdown',
url='https://github.com/mschwager/gitem',
packages=find_packages(where=PACKAGE_DIRECTORY),
package_dir={'': PACKAGE_DIRECTORY},
license='GPLv3',
classifiers=[
'Environment :: Console',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Operating System :: MacOS :: MacOS X',
'Operating System :: Microsoft :: Windows',
'Operating System :: POSIX',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
],
install_requires=install_requires,
tests_require=tests_require,
entry_points={
'console_scripts': [
'gitem = gitem.__main__:main',
],
},
)
================================================
FILE: tests/mocked_api_results.py
================================================
#!/usr/bin/env python
import requests
STANDARD_API_RESULT = [
{
"api results": "go here",
},
requests.codes.OK,
]
PAGED_API_RESULT = [
STANDARD_API_RESULT,
STANDARD_API_RESULT,
STANDARD_API_RESULT,
]
INVALID_JSON_RESULT = [
{
"message": "Problems parsing JSON",
},
requests.codes.BAD_REQUEST,
]
BAD_JSON_VALUES_RESULT = [
{
"message": "Body should be a JSON object",
},
requests.codes.BAD_REQUEST,
]
INVALID_FIELDS_RESULT = [
{
"message": "Validation Failed",
"errors": [
{
"resource": "Issue",
"field": "title",
"code": "missing_field",
}
],
},
requests.codes.UNPROCESSABLE_ENTITY,
]
BAD_CREDENTIALS_RESULT = [
{
"message": "Bad credentials",
"documentation_url": "https://developer.github.com/v3",
},
requests.codes.UNAUTHORIZED,
]
MAXIMUM_BAD_CREDENTIALS_RESULT = [
{
"message": "Maximum number of login attempts exceeded. Please try again later.",
"documentation_url": "https://developer.github.com/v3",
},
requests.codes.FORBIDDEN,
]
NOT_FOUND_RESULT = [
{
"message": "Not Found",
"documentation_url": "https://developer.github.com/v3",
},
requests.codes.NOT_FOUND,
]
def get_result_value(result):
return result[0]
def get_result_status_code(result):
return result[1]
================================================
FILE: tests/test_analytics.py
================================================
#!/usr/bin/env python
import collections
import unittest
try:
# Python 3
from unittest import mock
except ImportError:
# Python 2 (third-party)
import mock
import requests
import pytest
from gitem import analytics
from gitem import api
class TestAnalytics(unittest.TestCase):
def test_get_organization_information(self):
return_value = (
{
'name': 'name1',
'description': 'desc1',
'blog': 'blog1',
'html_url': 'hu1',
'created_at': 'ca1',
'updated_at': 'ua1',
'email': 'email1',
'location': 'loc1',
'login': 'test1',
'public_repos': 'pr1',
},
requests.codes.OK,
)
ghapi = mock.MagicMock()
ghapi.get_public_organization = mock.MagicMock(
return_value=return_value
)
result = analytics.get_organization_information(ghapi, "unused")
expected = collections.OrderedDict([
('Organization Name', 'name1'),
('Description', 'desc1'),
('Website', 'blog1'),
('Github URL', 'hu1'),
('Created', 'ca1'),
('Last Updated', 'ua1'),
('Email Address', 'email1'),
('Location', 'loc1'),
('Username', 'test1'),
('# of Public Repositories', 'pr1'),
])
assert result == expected
def test_get_organization_repositories(self):
return_value = [
(
[{
'name': 'name1',
'description': 'desc1',
'html_url': 'hu1',
'clone_url': 'cu1',
'watchers_count': 'wc1',
'stargazers_count': 'sc1',
'forks_count': 'fc1',
'created_at': 'ca1',
'updated_at': 'ua1',
'pushed_at': 'pa1',
}],
requests.codes.OK,
),
]
ghapi = mock.MagicMock()
ghapi.get_organizations_public_repositories = mock.MagicMock(
return_value=return_value
)
result = analytics.get_organization_repositories(ghapi, "unused")
expected = [
collections.OrderedDict([
('Repository Name', 'name1'),
('Description', 'desc1'),
('Github URL', 'hu1'),
('Clone URL', 'cu1'),
('Watchers', 'wc1'),
('Stars', 'sc1'),
('Forks', 'fc1'),
('Created', 'ca1'),
('Last Updated', 'ua1'),
('Last Pushed', 'pa1'),
]),
]
assert result == expected
def test_get_organization_members(self):
return_value = [
(
[{
'login': 'test1',
'site_admin': 'sa1',
'html_url': 'hu1',
}],
requests.codes.OK,
),
(
[{
'login': 'test2',
'site_admin': 'sa2',
'html_url': 'hu2',
}],
requests.codes.OK,
),
]
ghapi = mock.MagicMock()
ghapi.get_organizations_public_members = mock.MagicMock(
return_value=return_value
)
result = analytics.get_organization_members(ghapi, "unused")
expected = [
collections.OrderedDict([
('Username', 'test1'),
('Site Administrator', 'sa1'),
('Github URL', 'hu1'),
]),
collections.OrderedDict([
('Username', 'test2'),
('Site Administrator', 'sa2'),
('Github URL', 'hu2'),
]),
]
assert result == expected
def test_get_repository_information(self):
return_value = (
{
'name': 'name1',
'description': 'desc1',
'homepage': 'home1',
'html_url': 'hu1',
'clone_url': 'cu1',
'created_at': 'ca1',
'updated_at': 'ua1',
'pushed_at': 'pa1',
'language': 'lang1',
'forks_count': 'fc1',
'stargazers_count': 'sc1',
'watchers_count': 'wc1',
},
requests.codes.OK,
)
ghapi = mock.MagicMock()
ghapi.get_public_repository = mock.MagicMock(
return_value=return_value
)
result = analytics.get_repository_information(ghapi, "unused", "unused")
expected = collections.OrderedDict([
('Repository Name', 'name1'),
('Description', 'desc1'),
('Homepage', 'home1'),
('Github URL', 'hu1'),
('Clone URL', 'cu1'),
('Created', 'ca1'),
('Last Updated', 'ua1'),
('Last Pushed', 'pa1'),
('Language', 'lang1'),
('Forks', 'fc1'),
('Stars', 'sc1'),
('Watchers', 'wc1'),
])
assert result == expected
def test_get_repository_contributors(self):
return_value = [
(
[{
'login': 'test1',
'contributions': 'cont1'
}],
requests.codes.OK
),
(
[{
'login': 'test2',
'contributions': 'cont2'
}],
requests.codes.OK
),
]
ghapi = mock.MagicMock()
ghapi.get_repository_contributors = mock.MagicMock(
return_value=return_value
)
result = analytics.get_repository_contributors(ghapi, "unused", "unused")
expected = [
collections.OrderedDict([
('Username', 'test1'),
('Contributions', 'cont1'),
]),
collections.OrderedDict([
('Username', 'test2'),
('Contributions', 'cont2'),
]),
]
assert result == expected
def test_get_user_information(self):
return_value = (
{
'login': 'username1',
'html_url': 'hu1',
'name': 'name1',
'company': 'co1',
'blog': 'blog1',
'location': 'loc1',
'email': 'email1',
'created_at': 'ca1',
'updated_at': 'ua1',
},
requests.codes.OK,
)
ghapi = mock.MagicMock()
ghapi.get_user = mock.MagicMock(
return_value=return_value
)
result = analytics.get_user_information(ghapi, "unused")
expected = collections.OrderedDict([
('Username', 'username1'),
('Github URL', 'hu1'),
('Name', 'name1'),
('Company', 'co1'),
('Blog', 'blog1'),
('Location', 'loc1'),
('Email Address', 'email1'),
('Created', 'ca1'),
('Updated', 'ua1'),
])
assert result == expected
def test_get_user_organization(self):
return_value = [
(
[{
'login': 'test1'
}],
requests.codes.OK
),
(
[{
'login': 'test2'
}],
requests.codes.OK
),
]
ghapi = mock.MagicMock()
ghapi.get_users_public_organizations = mock.MagicMock(
return_value=return_value
)
result = analytics.get_user_organizations(ghapi, "unused")
expected = [
collections.OrderedDict([
('Organization', 'test1'),
]),
collections.OrderedDict([
('Organization', 'test2'),
]),
]
assert result == expected
def test_get_user_repositories(self):
return_value = [
(
[{
'name': 'name1',
'description': 'desc1',
'html_url': 'hu1',
'clone_url': 'cu1',
}],
requests.codes.OK,
)
]
ghapi = mock.MagicMock()
ghapi.get_users_public_repositories = mock.MagicMock(
return_value=return_value
)
result = analytics.get_user_repositories(ghapi, "unused")
expected = [
collections.OrderedDict([
('Repository Name', 'name1'),
('Description', 'desc1'),
('Github URL', 'hu1'),
('Clone URL', 'cu1'),
])
]
assert result == expected
def test_get_repository_commit_emails_basic(self):
return_value = [
(
[{
'commit': {
'author': {
'name': 'username1',
'email': 'email1',
},
},
}],
requests.codes.OK,
)
]
ghapi = mock.MagicMock()
ghapi.get_repository_commits = mock.MagicMock(
return_value=return_value
)
result = analytics.get_repository_commit_emails(ghapi, "unused", "unused")
expected = {('username1', 'email1')}
assert result == expected
def test_get_repository_commit_emails_conflict(self):
def conflict_generator():
raise api.ApiCallException(requests.codes.CONFLICT, "unused")
yield # Empty yield to make this a generator
return_value = conflict_generator()
ghapi = mock.MagicMock()
ghapi.get_repository_commits = mock.MagicMock(
return_value=return_value
)
result = analytics.get_repository_commit_emails(ghapi, "unused", "unused")
expected = set()
assert result == expected
def test_get_repository_commit_emails_not_conflict(self):
def not_conflict_generator():
raise api.ApiCallException(requests.codes.BAD_REQUEST, "unused")
yield # Empty yield to make this a generator
return_value = not_conflict_generator()
ghapi = mock.MagicMock()
ghapi.get_repository_commits = mock.MagicMock(
return_value=return_value
)
with pytest.raises(api.ApiCallException):
analytics.get_repository_commit_emails(ghapi, "unused", "unused")
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_api.py
================================================
#!/usr/bin/env python
import unittest
try:
# Python 3
from unittest import mock
except ImportError:
# Python 2 (third-party)
import mock
import requests
import pytest
from gitem import api
import mocked_api_results
class TestApi(unittest.TestCase):
def assertOk(self, status_code):
assert status_code == requests.codes.OK
def assertEmpty(self, iterable):
assert len(iterable) == 0
@staticmethod
def api_will_return(json_return_value, status_code=requests.codes.OK, oauth2_token=None):
assert isinstance(json_return_value, dict)
return_value = mock.MagicMock()
return_value.status_code = status_code
return_value.json = mock.MagicMock(
return_value=json_return_value
)
return_value.ok = status_code == requests.codes.OK
return api.Api(oauth2_token, requester=mock.MagicMock(
return_value=return_value
))
@staticmethod
def paged_api_will_return(json_return_values, status_codes=None, oauth2_token=None):
assert isinstance(json_return_values, list)
assert isinstance(status_codes, list) or status_codes is None
if status_codes is None:
status_codes = [requests.codes.OK] * len(json_return_values)
return_value = mock.MagicMock()
# This is some weird mock black magic...
type(return_value).status_code = mock.PropertyMock(
side_effect=status_codes
)
return_value.json = mock.Mock(
side_effect=json_return_values
)
type(return_value).ok = mock.PropertyMock(
side_effect=[
status_code == requests.codes.OK
for status_code in status_codes
]
)
return api.Api(oauth2_token, requester=mock.MagicMock(
return_value=return_value
))
def test_ok(self):
will_return = mocked_api_results.STANDARD_API_RESULT
mocked_api = self.api_will_return(*will_return)
# The API call we make doesn't matter, it will return the same result
# no matter what
result, status_code = mocked_api.get_public_organization("unused")
expected = mocked_api_results.get_result_value(
mocked_api_results.STANDARD_API_RESULT
)
self.assertOk(status_code)
assert result == expected
def test_invalid_json(self):
will_return = mocked_api_results.INVALID_JSON_RESULT
mocked_api = self.api_will_return(*will_return)
# The API call we make doesn't matter, it will return the same result
# no matter what
with pytest.raises(api.ApiCallException) as e:
mocked_api.get_public_organization("unused")
assert e.value.bad_request
def test_invalid_json_argument_type(self):
will_return = mocked_api_results.BAD_JSON_VALUES_RESULT
mocked_api = self.api_will_return(*will_return)
# The API call we make doesn't matter, it will return the same result
# no matter what
with pytest.raises(api.ApiCallException) as e:
mocked_api.get_public_organization("unused")
assert e.value.bad_request
def test_invalid_json_field(self):
will_return = mocked_api_results.INVALID_FIELDS_RESULT
mocked_api = self.api_will_return(*will_return)
# The API call we make doesn't matter, it will return the same result
# no matter what
with pytest.raises(api.ApiCallException) as e:
mocked_api.get_public_organization("unused")
assert e.value.unprocessable_entity
def test_bad_credentials(self):
will_return = mocked_api_results.BAD_CREDENTIALS_RESULT
mocked_api = self.api_will_return(*will_return)
# The API call we make doesn't matter, it will return the same result
# no matter what
with pytest.raises(api.ApiCallException) as e:
mocked_api.get_public_organization("unused")
assert e.value.unauthorized
def test_maximum_bad_credentials(self):
will_return = mocked_api_results.MAXIMUM_BAD_CREDENTIALS_RESULT
mocked_api = self.api_will_return(*will_return)
# The API call we make doesn't matter, it will return the same result
# no matter what
with pytest.raises(api.ApiCallException) as e:
mocked_api.get_public_organization("unused")
assert e.value.forbidden
def test_not_found(self):
will_return = mocked_api_results.NOT_FOUND_RESULT
mocked_api = self.api_will_return(*will_return)
# The API call we make doesn't matter, it will return the same result
# no matter what
with pytest.raises(api.ApiCallException) as e:
mocked_api.get_public_organization("unused")
assert e.value.not_found
def test_authenticated_endpoint_ok(self):
will_return = mocked_api_results.STANDARD_API_RESULT
mocked_api = self.api_will_return(
*will_return,
oauth2_token="VALUE DOESN'T MATTER"
)
result, status_code = mocked_api.get_organization("unused")
expected = mocked_api_results.get_result_value(
mocked_api_results.STANDARD_API_RESULT
)
self.assertOk(status_code)
assert result == expected
def test_authenticated_endpoint_missing_token(self):
will_return = mocked_api_results.STANDARD_API_RESULT
mocked_api = self.api_will_return(
*will_return,
oauth2_token=None
)
with pytest.raises(api.AuthenticationRequiredException):
mocked_api.get_organization("unused")
def test_paged_ok(self):
mocked_json_values = [
mocked_api_results.get_result_value(result)
for result in mocked_api_results.PAGED_API_RESULT
]
mocked_status_codes = [
mocked_api_results.get_result_status_code(result)
for result in mocked_api_results.PAGED_API_RESULT
]
mocked_api = self.paged_api_will_return(mocked_json_values, mocked_status_codes)
for result, status_code in mocked_api.get_organizations_public_repositories("unused"):
expected = mocked_api_results.get_result_value(
mocked_api_results.STANDARD_API_RESULT
)
self.assertOk(status_code)
assert result == expected
def test_paged_pep_479(self):
mocked_json_values = [
mocked_api_results.get_result_value(result)
for result in mocked_api_results.PAGED_API_RESULT
]
mocked_json_values = [mocked_json_values[0]]
mocked_api = self.paged_api_will_return(mocked_json_values)
mocked_api.requester.return_value.ok = mock.PropertyMock(
side_effect=StopIteration
)
result = list(mocked_api.get_organizations_public_repositories("unused"))
self.assertEmpty(result)
def test_get_users_public_repositories_bad_type(self):
type_ = ""
ghapi = api.Api()
with pytest.raises(ValueError):
ghapi.get_users_public_repositories("UNUSED", type_=type_)
def test_get_users_public_repositories_bad_sort(self):
sort = ""
ghapi = api.Api()
with pytest.raises(ValueError):
ghapi.get_users_public_repositories("UNUSED", sort=sort)
def test_get_users_public_repositories_bad_direction(self):
direction = ""
ghapi = api.Api()
with pytest.raises(ValueError):
ghapi.get_users_public_repositories("UNUSED", direction=direction)
def test_get_organizations_public_repositories_bad_type(self):
type_ = ""
ghapi = api.Api()
with pytest.raises(ValueError):
ghapi.get_organizations_public_repositories("UNUSED", type_=type_)
def test_get_repository_contributors_bad_anon(self):
anon = ""
ghapi = api.Api()
with pytest.raises(ValueError):
ghapi.get_repository_contributors("UNUSED", "UNUSED", anon=anon)
def test_get_repository_contributors_ok(self):
mocked_json_values = [
mocked_api_results.get_result_value(result)
for result in mocked_api_results.PAGED_API_RESULT
]
mocked_status_codes = [
mocked_api_results.get_result_status_code(result)
for result in mocked_api_results.PAGED_API_RESULT
]
mocked_api = self.paged_api_will_return(mocked_json_values, mocked_status_codes)
for result, status_code in mocked_api.get_repository_contributors("unused", "unused"):
expected = mocked_api_results.get_result_value(
mocked_api_results.STANDARD_API_RESULT
)
self.assertOk(status_code)
assert result == expected
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_output/test_json.py
================================================
#!/usr/bin/env python
import collections
import io
import textwrap
import unittest
from gitem import output
class TestJson(unittest.TestCase):
@staticmethod
def dedent_helper(s):
return textwrap.dedent(s).lstrip()
def test_basic(self):
data = collections.OrderedDict([
('key', 'value'),
])
with io.StringIO() as stream:
outputter = output.Json(file_=stream)
outputter.output(data)
result = stream.getvalue()
expected = self.dedent_helper('''
{"key":"value"}
''')
assert result == expected
def test_list(self):
data = collections.OrderedDict([
('key1', collections.OrderedDict([
('key2', ['value1', 'value2']),
])),
])
with io.StringIO() as stream:
outputter = output.Json(file_=stream)
outputter.output(data)
result = stream.getvalue()
expected = self.dedent_helper('''
{"key1":{"key2":["value1","value2"]}}
''')
assert result == expected
def test_recurse(self):
data = collections.OrderedDict([
('key1', 'value1'),
('key2', collections.OrderedDict([
('key3', 'value2'),
])),
])
with io.StringIO() as stream:
outputter = output.Json(file_=stream)
outputter.output(data)
result = stream.getvalue()
expected = self.dedent_helper('''
{"key1":"value1","key2":{"key3":"value2"}}
''')
assert result == expected
def test_multi(self):
data1 = collections.OrderedDict([
('key1', 'value1'),
])
data2 = collections.OrderedDict([
('key2', 'value2'),
])
with io.StringIO() as stream:
outputter = output.Json(file_=stream)
outputter.output(data1)
outputter.output(data2)
result = stream.getvalue()
expected = self.dedent_helper('''
{"key1":"value1"}
{"key2":"value2"}
''')
assert result == expected
if __name__ == "__main__":
unittest.main()
================================================
FILE: tests/test_output/test_stdout.py
================================================
#!/usr/bin/env python
import collections
import io
import textwrap
import unittest
from gitem import output
class TestStdout(unittest.TestCase):
@staticmethod
def dedent_helper(s):
return textwrap.dedent(s).lstrip()
def test_basic(self):
data = collections.OrderedDict([
('key', 'value'),
])
with io.StringIO() as stream:
outputter = output.Stdout(file_=stream)
outputter.output(data)
result = stream.getvalue()
expected = self.dedent_helper('''
key: value
''')
assert result == expected
def test_list(self):
data = collections.OrderedDict([
('key1', collections.OrderedDict([
('key2', ['value1', 'value2']),
])),
])
with io.StringIO() as stream:
outputter = output.Stdout(file_=stream)
outputter.output(data)
result = stream.getvalue()
expected = self.dedent_helper('''
key1:
key2:
value1
value2
''')
assert result == expected
def test_recurse(self):
data = collections.OrderedDict([
('key1', 'value1'),
('key2', collections.OrderedDict([
('key3', 'value2'),
])),
])
with io.StringIO() as stream:
outputter = output.Stdout(file_=stream)
outputter.output(data)
result = stream.getvalue()
expected = self.dedent_helper('''
key1: value1
key2:
key3: value2
''')
assert result == expected
def test_newline(self):
data = collections.OrderedDict([
('key1', 'value1'),
('key2', collections.OrderedDict([
('key3', 'value2'),
])),
('key4', collections.OrderedDict([
('key5', 'value3'),
])),
])
with io.StringIO() as stream:
outputter = output.Stdout(file_=stream)
outputter.output(data)
result = stream.getvalue()
expected = self.dedent_helper('''
key1: value1
key2:
key3: value2
key4:
key5: value3
''')
assert result == expected
def test_multi(self):
data1 = collections.OrderedDict([
('key1', 'value1'),
])
data2 = collections.OrderedDict([
('key2', 'value2'),
])
with io.StringIO() as stream:
outputter = output.Stdout(file_=stream)
outputter.output(data1)
outputter.output(data2)
result = stream.getvalue()
expected = self.dedent_helper('''
key1: value1
key2: value2
''')
assert result == expected
if __name__ == "__main__":
unittest.main()
gitextract_or3k8zjn/
├── .coveragerc
├── .flake8
├── .github/
│ └── workflows/
│ └── main.yml
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── lib/
│ └── gitem/
│ ├── __init__.py
│ ├── __main__.py
│ ├── analytics.py
│ ├── api.py
│ └── output/
│ ├── __init__.py
│ ├── base.py
│ ├── json.py
│ └── stdout.py
├── requirements-dev.txt
├── requirements.txt
├── setup.cfg
├── setup.py
└── tests/
├── mocked_api_results.py
├── test_analytics.py
├── test_api.py
└── test_output/
├── test_json.py
└── test_stdout.py
SYMBOL INDEX (100 symbols across 11 files)
FILE: lib/gitem/__main__.py
function organization (line 22) | def organization(ghapi, outputter, *args, **kwargs):
function repository (line 88) | def repository(ghapi, outputter, *args, **kwargs):
function user (line 119) | def user(ghapi, outputter, *args, **kwargs):
function parse_args (line 198) | def parse_args():
function main (line 267) | def main():
FILE: lib/gitem/analytics.py
function get_organization_information (line 15) | def get_organization_information(ghapi, organization):
function get_organization_repositories (line 41) | def get_organization_repositories(ghapi, organization):
function get_organization_members (line 71) | def get_organization_members(ghapi, organization):
function get_repository_information (line 94) | def get_repository_information(ghapi, owner, repository):
function get_repository_contributors (line 123) | def get_repository_contributors(ghapi, owner, repository):
function get_user_information (line 146) | def get_user_information(ghapi, username):
function get_user_organizations (line 171) | def get_user_organizations(ghapi, username):
function get_user_repositories (line 192) | def get_user_repositories(ghapi, username):
function get_repository_commit_emails (line 221) | def get_repository_commit_emails(ghapi, owner, repository, author=None):
FILE: lib/gitem/api.py
class AuthenticationRequiredException (line 16) | class AuthenticationRequiredException(BaseException):
class ApiCallException (line 20) | class ApiCallException(BaseException):
method __init__ (line 24) | def __init__(self, code, message):
method bad_request (line 29) | def bad_request(self):
method unprocessable_entity (line 33) | def unprocessable_entity(self):
method forbidden (line 37) | def forbidden(self):
method unauthorized (line 41) | def unauthorized(self):
method conflict (line 45) | def conflict(self):
method not_found (line 49) | def not_found(self):
method rate_limiting (line 53) | def rate_limiting(self):
method __str__ (line 59) | def __str__(self):
function oauth2_required (line 63) | def oauth2_required(func):
class Api (line 72) | class Api(object):
method __init__ (line 76) | def __init__(self, oauth2_token=None, requester=requests.request):
method call (line 85) | def call(self, method, url, params=None):
method json_call (line 102) | def json_call(self, method, endpoint, params=None):
method paginated_json_call (line 114) | def paginated_json_call(self, method, endpoint, params=None):
method get_user (line 135) | def get_user(self, username):
method get_users_organizations (line 150) | def get_users_organizations(self):
method get_users_public_organizations (line 164) | def get_users_public_organizations(self, username):
method get_users_public_repositories (line 178) | def get_users_public_repositories(self, username, type_=None, sort=Non...
method get_public_organization (line 211) | def get_public_organization(self, organization):
method get_organization (line 226) | def get_organization(self, organization):
method get_organizations_public_repositories (line 235) | def get_organizations_public_repositories(self, organization, type_=No...
method get_organizations_public_members (line 256) | def get_organizations_public_members(self, organization):
method get_public_repository (line 270) | def get_public_repository(self, owner, repository):
method get_repository_contributors (line 284) | def get_repository_contributors(self, owner, repository, anon=None):
method get_repository_commits (line 305) | def get_repository_commits(self, owner, repository, sha=None, path=None,
FILE: lib/gitem/output/base.py
class Base (line 19) | class Base(ABC):
method __init__ (line 23) | def __init__(self, file_=sys.stdout):
method output (line 27) | def output(self):
FILE: lib/gitem/output/json.py
class Json (line 15) | class Json(base.Base):
method output (line 19) | def output(self, data):
FILE: lib/gitem/output/stdout.py
class Stdout (line 13) | class Stdout(base.Base):
method __init__ (line 18) | def __init__(self, *args, **kwargs):
method output_helper (line 23) | def output_helper(self, data, depth):
method output (line 51) | def output(self, data):
FILE: tests/mocked_api_results.py
function get_result_value (line 71) | def get_result_value(result):
function get_result_status_code (line 75) | def get_result_status_code(result):
FILE: tests/test_analytics.py
class TestAnalytics (line 20) | class TestAnalytics(unittest.TestCase):
method test_get_organization_information (line 22) | def test_get_organization_information(self):
method test_get_organization_repositories (line 61) | def test_get_organization_repositories(self):
method test_get_organization_members (line 104) | def test_get_organization_members(self):
method test_get_repository_information (line 146) | def test_get_repository_information(self):
method test_get_repository_contributors (line 189) | def test_get_repository_contributors(self):
method test_get_user_information (line 227) | def test_get_user_information(self):
method test_get_user_organization (line 264) | def test_get_user_organization(self):
method test_get_user_repositories (line 298) | def test_get_user_repositories(self):
method test_get_repository_commit_emails_basic (line 329) | def test_get_repository_commit_emails_basic(self):
method test_get_repository_commit_emails_conflict (line 355) | def test_get_repository_commit_emails_conflict(self):
method test_get_repository_commit_emails_not_conflict (line 373) | def test_get_repository_commit_emails_not_conflict(self):
FILE: tests/test_api.py
class TestApi (line 20) | class TestApi(unittest.TestCase):
method assertOk (line 22) | def assertOk(self, status_code):
method assertEmpty (line 25) | def assertEmpty(self, iterable):
method api_will_return (line 29) | def api_will_return(json_return_value, status_code=requests.codes.OK, ...
method paged_api_will_return (line 45) | def paged_api_will_return(json_return_values, status_codes=None, oauth...
method test_ok (line 72) | def test_ok(self):
method test_invalid_json (line 88) | def test_invalid_json(self):
method test_invalid_json_argument_type (line 100) | def test_invalid_json_argument_type(self):
method test_invalid_json_field (line 112) | def test_invalid_json_field(self):
method test_bad_credentials (line 124) | def test_bad_credentials(self):
method test_maximum_bad_credentials (line 136) | def test_maximum_bad_credentials(self):
method test_not_found (line 148) | def test_not_found(self):
method test_authenticated_endpoint_ok (line 160) | def test_authenticated_endpoint_ok(self):
method test_authenticated_endpoint_missing_token (line 177) | def test_authenticated_endpoint_missing_token(self):
method test_paged_ok (line 188) | def test_paged_ok(self):
method test_paged_pep_479 (line 209) | def test_paged_pep_479(self):
method test_get_users_public_repositories_bad_type (line 225) | def test_get_users_public_repositories_bad_type(self):
method test_get_users_public_repositories_bad_sort (line 232) | def test_get_users_public_repositories_bad_sort(self):
method test_get_users_public_repositories_bad_direction (line 239) | def test_get_users_public_repositories_bad_direction(self):
method test_get_organizations_public_repositories_bad_type (line 246) | def test_get_organizations_public_repositories_bad_type(self):
method test_get_repository_contributors_bad_anon (line 253) | def test_get_repository_contributors_bad_anon(self):
method test_get_repository_contributors_ok (line 260) | def test_get_repository_contributors_ok(self):
FILE: tests/test_output/test_json.py
class TestJson (line 11) | class TestJson(unittest.TestCase):
method dedent_helper (line 14) | def dedent_helper(s):
method test_basic (line 17) | def test_basic(self):
method test_list (line 33) | def test_list(self):
method test_recurse (line 51) | def test_recurse(self):
method test_multi (line 70) | def test_multi(self):
FILE: tests/test_output/test_stdout.py
class TestStdout (line 11) | class TestStdout(unittest.TestCase):
method dedent_helper (line 14) | def dedent_helper(s):
method test_basic (line 17) | def test_basic(self):
method test_list (line 33) | def test_list(self):
method test_recurse (line 54) | def test_recurse(self):
method test_newline (line 76) | def test_newline(self):
method test_multi (line 104) | def test_multi(self):
Condensed preview — 25 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (104K chars).
[
{
"path": ".coveragerc",
"chars": 25,
"preview": "[report]\ninclude = lib/*\n"
},
{
"path": ".flake8",
"chars": 67,
"preview": "[flake8]\nignore = E501,W503\ninclude = lib,tests\nexclude = setup.py\n"
},
{
"path": ".github/workflows/main.yml",
"chars": 183,
"preview": "name: Dlint\non: [push, pull_request]\njobs:\n dlint:\n runs-on: ubuntu-latest\n name: Dlint\n steps:\n - uses: ac"
},
{
"path": ".gitignore",
"chars": 1060,
"preview": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packagi"
},
{
"path": ".travis.yml",
"chars": 376,
"preview": "dist: xenial\nlanguage: python\ncache: pip\npython:\n - 2.7\n - 3.5\n - 3.6\n - 3.7\n - 3.8-dev\nbefore_install:\n "
},
{
"path": "CHANGELOG.md",
"chars": 1310,
"preview": "# Change Log\nAll notable changes to this project will be documented in this file.\nThis project adheres to [Semantic Vers"
},
{
"path": "LICENSE",
"chars": 35141,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "README.md",
"chars": 4250,
"preview": "# Gitem\n\n[](https://travis-ci.org/mschwager/gite"
},
{
"path": "lib/gitem/__init__.py",
"chars": 266,
"preview": "from __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_literals,\n)\n\nfrom . import a"
},
{
"path": "lib/gitem/__main__.py",
"chars": 8190,
"preview": "#!/usr/bin/env python\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_liter"
},
{
"path": "lib/gitem/analytics.py",
"chars": 7465,
"preview": "#!/usr/bin/env python\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_liter"
},
{
"path": "lib/gitem/api.py",
"chars": 9433,
"preview": "#!/usr/bin/env python\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_liter"
},
{
"path": "lib/gitem/output/__init__.py",
"chars": 196,
"preview": "from __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_literals,\n)\n\nfrom .stdout im"
},
{
"path": "lib/gitem/output/base.py",
"chars": 415,
"preview": "#!/usr/bin/env python\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_liter"
},
{
"path": "lib/gitem/output/json.py",
"chars": 329,
"preview": "#!/usr/bin/env python\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_liter"
},
{
"path": "lib/gitem/output/stdout.py",
"chars": 1559,
"preview": "#!/usr/bin/env python\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_liter"
},
{
"path": "requirements-dev.txt",
"chars": 63,
"preview": "pytest==4.6.5\npytest-cov==2.8.1\nflake8==3.7.9\ncoveralls==1.8.2\n"
},
{
"path": "requirements.txt",
"chars": 17,
"preview": "requests==2.20.0\n"
},
{
"path": "setup.cfg",
"chars": 28,
"preview": "[bdist_wheel]\nuniversal = 1\n"
},
{
"path": "setup.py",
"chars": 1838,
"preview": "from setuptools import (\n find_packages,\n setup,\n)\n\nimport os\nimport sys\n\nPACKAGE_DIRECTORY = 'lib'\n\nsys.path.appe"
},
{
"path": "tests/mocked_api_results.py",
"chars": 1458,
"preview": "#!/usr/bin/env python\n\nimport requests\n\nSTANDARD_API_RESULT = [\n {\n \"api results\": \"go here\",\n },\n reque"
},
{
"path": "tests/test_analytics.py",
"chars": 10900,
"preview": "#!/usr/bin/env python\n\nimport collections\nimport unittest\n\ntry:\n # Python 3\n from unittest import mock\nexcept Impo"
},
{
"path": "tests/test_api.py",
"chars": 8948,
"preview": "#!/usr/bin/env python\n\nimport unittest\n\ntry:\n # Python 3\n from unittest import mock\nexcept ImportError:\n # Pyth"
},
{
"path": "tests/test_output/test_json.py",
"chars": 2239,
"preview": "#!/usr/bin/env python\n\nimport collections\nimport io\nimport textwrap\nimport unittest\n\nfrom gitem import output\n\n\nclass Te"
},
{
"path": "tests/test_output/test_stdout.py",
"chars": 2970,
"preview": "#!/usr/bin/env python\n\nimport collections\nimport io\nimport textwrap\nimport unittest\n\nfrom gitem import output\n\n\nclass Te"
}
]
About this extraction
This page contains the full source code of the mschwager/gitem GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 25 files (96.4 KB), approximately 22.1k tokens, and a symbol index with 100 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.