diff --git a/CHANGELOG.md b/CHANGELOG.md index ed02da0..1ace9e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,18 +5,18 @@ All notable changes to this project will be documented in this file. This projec ## [Unreleased][unreleased] -## [1.2.0rc2] - 2015-07-21 - I haven't named it yet, cut me some slack. +## [1.2.0] - 2015-07-21 - Your Cipher is all Over my Necktie ### Changed -- `jss.ComputerGroup`s that are made with the `new` method now include the `computers` subelement. +- `jss.ComputerGroup`s that are made with the `new` method now include the `computers` subelement. Strangely, even smart groups include a computers tag. If previously populated with computer objects, it will retain them! - Removed bundled copy of python requests. - Using setuptools `setup.py` property `install_requires` to specify dependencies: - requests - pyasn1 - ndg-httpsclient - Previous two required for cipher change support. -- TODO: Updated documentation to describe this requirement for developer (i.e. anyone who does not use the egg or wheel files to install). +- Updated documentation to describe this requirement for developer (i.e. anyone who does not use the egg or wheel files to install). - `JSS.base_url` (Get and Set) and `JSS._url` (Read only) are now proper properties. ### Fixed @@ -462,8 +462,8 @@ I did a quick update to include an egg installer on pypi.org. This was needed to - Initial release. -[unreleased]: https://github.com/sheagcraig/python-jss/compare/v1.2.0rc2...HEAD -[1.2.0rc2]: https://github.com/sheagcraig/python-jss/compare/v1.1.0...v1.2.0rc2 +[unreleased]: https://github.com/sheagcraig/python-jss/compare/v1.2.0...HEAD +[1.2.0]: https://github.com/sheagcraig/python-jss/compare/v1.1.0...v1.2.0 [1.1.0]: https://github.com/sheagcraig/python-jss/compare/v1.0.2...v1.1.0 [1.0.2]: https://github.com/sheagcraig/python-jss/compare/v1.0.1...v1.0.2 [1.0.1]: https://github.com/sheagcraig/python-jss/compare/v1.0.0...v1.0.1 diff --git a/README.md b/README.md index e2b66d6..910cd96 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -python-jss Introduction: -================= +# python-jss + +## Introduction: This project aims to offer simple, elegant, pythonic access to the Jamf Casper JSS API. Jamf provides access to the JSS and most of its object types through a REST @@ -11,43 +12,36 @@ is primarily centered on Computer management, and specifically, those aspects which factor into policy and package management. Automating policy creation is streamlined; however, class -```MobileDeviceInvitations``` provides nothing beyond basic ```JSSObject``` +`MobileDeviceInvitations` provides nothing beyond basic `JSSObject` methods and properties to the API. Those aspects which I use heavily in our organization, and in support of [JSSImporter](https://www.github.com/sheagcraig/JSSImporter), tend to be more fleshed out, whereas aspects of the JSS API that I never use tend to be minimalistic. However, based on the code here, it should be easy for anyone -wishing to do so to implement a ```new()``` method for those objects they're +wishing to do so to implement a `new()` method for those objects they're interested in, and I would be happy to include them. Send me your pull requests! -Installing: -================= +## Installing: The easiest method is to use pip to grab python-jss: -``` -$ pip install python-jss -``` +`$ pip install python-jss` If you don't have pip, you should probably get it: https://pip.pypa.io/en/latest/installing.html Alternately, download the source and copy the python-jss package wherever you normally install your packages. -Behind the scenes, python-jss uses requests and Greg Neagle's FoundationPlist. -Check them out at: -requests: http://docs.python-requests.org/en/latest/ -FoundationPlist is part of Munki: https://code.google.com/p/munki/ +Behind the scenes, python-jss requires the requests, pyasn1, and ndg-httpsclient packages. If you install using easy-install or pip, these dependencies are handled for you. Otherwise, you'll have to acquire them yourself: +`easy_install pyasn1 ndg-httpsclient requests` -Linux: -================= +## Linux: python-jss on Linux has some extra dependencies if you need to be able to mount distribution points. -- AFP distribution points require the ```fuse-afp``` package. -- SMB distribution points require the ```cifs-utils``` package. +- AFP distribution points require the `fuse-afp` package. +- SMB distribution points require the `cifs-utils` package. As I'm currently developing on Fedora, these requirements are specific to RedHat-based distros. Feel free to test and comment on Debian so I can update! -Usage: -================= +## Usage: Please see [the wiki](https://github.com/sheagcraig/python-jss/wiki) for complete documentation. Also, [my blog](http://labs.da.org/wordpress/sheagcraig/) has a series of posts about using [python-jss](https://github.com/sheagcraig/python-jss), [JSSImporter](https://github.com/sheagcraig/JSSImporter), and [jss_helper](https://github.com/sheagcraig/jss_helper), and solving unique problems using these tools. diff --git a/jss/__init__.py b/jss/__init__.py index 468d0b2..7c89093 100644 --- a/jss/__init__.py +++ b/jss/__init__.py @@ -31,4 +31,4 @@ JSSUnsupportedFileType, JSSError) from tools import is_osx, is_linux -__version__ = "1.2.0rc2" +__version__ = "1.2.0"