Skip to content

Commit

Permalink
Updating
Browse files Browse the repository at this point in the history
  • Loading branch information
jlbloomer committed Jun 5, 2019
1 parent 5b8dc10 commit 93487c7
Show file tree
Hide file tree
Showing 15 changed files with 202 additions and 134 deletions.
129 changes: 0 additions & 129 deletions README.md

This file was deleted.

181 changes: 181 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
SnipeIT Python API
==================

Use this package to interface with the SnipeIT (https://snipeitapp.com/)
API directly from Python.

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

Run the command ``pip install snipeit``

Usage
-----

- See Example Scripts included in package for specific calls

API Features
------------

- ☒ Hardware
- ☒ Companies
- ☒ Locations
- ☒ Accessories
- ☒ Consumables
- ☒ Components
- ☒ Users
- ☒ Status Labels
- ☒ Models
- ☒ Licenses
- ☒ Categories
- ☒ Manufacturers
- ☒ Custom Fieldsets
- ☒ Maintenances

|Completed|

Release History
---------------

- 0.11

- Completing API features based on Snipe-IT version 4.6.14

- Added Categories class
- Added Fieldsets class
- Added Missing Licenses class
- Added Manufacturers class
- Added Maintenances class
- Added docstrings for each methods
- Removed unrelated methods in some classes
- Added search() method for all supported APIs
- Update get() methods to incorporate ordering
- Added many new methods in each class (see documentation files)
- Added documentation files

- 0.10

- Update import issue in python3

- Updated **init**.py to python 3 import style

- 0.9

- Created Support for Models

- Added get() method to get JSON dump of Models
- Added create() method to add new items to Models
- Added getID() method to get the ID of a specified Models
- Added delete() method to remove items from Models
- Added updateModel() method (Uses PATCH call) to update details
on a existing Model

- 0.8

- Created Support for StatusLabels

- Added get() method to get JSON dump of Status Labels
- Added create() method to add new items to Status Labels
- Added getID() method to get the ID of a specified Status Labels
- Added delete() method to remove items from Status Labels
- Added updateStatusLabels() method (Uses PATCH call) to update
details on a existing Status Label

- 0.7

- Created Support for Users

- Added get() method to get JSON dump of Users
- Added create() method to add new items to Users
- Added getID() method to get the ID of a specified Users
- Added delete() method to remove items from Users
- Added updateUser() method (Uses PATCH call) to update details
on a existing Users
- Added getCheckedOutAssets() method to get a list of Assets
assigned to that User

- 0.6

- Created Support for Components

- Added get() method to get JSON dump of Components
- Added create() method to add new items to Components
- Added getID() method to get the ID of a specified Components
- Added viewID() method to see details of Components

- 0.5

- Creating Support for Consumable API Calls

- Added get() method to get JSON dump of Consumables
- Added create() method to add new items to Consumables
- Added getID() method to get the ID of a specified consumable
- Added viewID() method to get details of a specific consumable

- 0.4

- Creating Support for Accessory API Calls

- Added get() method to get JSON dump of AccessoriesID
- Added create() method to add new items to Accessories
- Added getID() method to get the ID of a specified accessories
- Added viewID() method to get details of a specific accessory

- 0.3

- Creating Support for Locations API Calls

- Added get() method to get JSON dump of locations
- Added create() method to add new items to locations
- Added getID() method to get the ID of a specified locations
- Added updateCompany() method (Uses PATCH call) to update the
name of an existing location.
- Added delete() method to remove items from locations

- 0.2

- Creating Support for Company API Calls

- Added get() method to get JSON dump of companies
- Added create() method to add new items to companies
- Added getID() method to get the ID of a specified company
- Added delete() method to remove items from companies
- Added updateCompany() method (Uses PATCH call) to update the
name of an existing company.

- 0.1

- Created Support for Assets

- Added get() method to get JSON dump of inventory
- Added create() method to add new items to inventory
- Added getID() method to get the ID of a specified device in the
inventory
- Added delete() method to remove items from inventory
- Added updateDevice() method (Uses PATCH call) to update details
on a device currently in inventory.

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

1. Fork it!
2. Create your feature branch: ``git checkout -b my-new-feature``
3. Commit your changes: ``git commit -am 'Add some feature'``
4. Push to the branch: ``git push origin my-new-feature``
5. Submit a pull request :D

Credits
-------

Cox Automotive Inc. \* https://www.coxautoinc.com/ \* Author: Jared
Bloomer

License
-------

This Project is currently released under the MIT license. For the latest
copy of the MIT license please refer to
https://opensource.org/licenses/MIT

.. |Completed| image:: http://progressed.io/bar/100?title=completed

Binary file removed dist/snipeit-0.10.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.11.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.2.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.4.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.5.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.6.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.7.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.8.tar.gz
Binary file not shown.
Binary file removed dist/snipeit-0.9.tar.gz
Binary file not shown.
Binary file added dist/snipeit-1.0.tar.gz
Binary file not shown.
Binary file added dist/snipeit-1.1.tar.gz
Binary file not shown.
9 changes: 4 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@
long_description = fh.read()

setup(name='snipeit',
version='0.11',
description='Python library to access the SnipeIT API',
url='https://github.com/veenone/SnipeIT-PythonAPI',
version='1.1',
long_description="""""",
description=("Python library to access the SnipeIT API"),
url='https://github.com/jbloomer/SnipeIT-PythonAPI',
author='Jared Bloomer (Cox Automotive Inc.)',
author_email='[email protected]',
license='MIT',
packages=['snipeit'],
install_requires=['requests','simplejson'],
long_description=long_description,
long_description_content_type="text/markdown",
zip_safe=False)
17 changes: 17 additions & 0 deletions setup.py.bak
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
from setuptools import setup

with open("README.md","r") as fh:
long_description = fh.read()

setup(name='snipeit',
version='1.1',
long_description=long_description,
long_description_content_type="text/markdown",
description=("Python library to access the SnipeIT API"),
url='https://github.com/jbloomer/SnipeIT-PythonAPI',
author='Jared Bloomer (Cox Automotive Inc.)',
author_email='[email protected]',
license='MIT',
packages=['snipeit'],
install_requires=['requests','simplejson'],
zip_safe=False)

0 comments on commit 93487c7

Please sign in to comment.