agsadmin


Nameagsadmin JSON
Version 0.5.3 PyPI version JSON
download
home_pagehttps://github.com/DavidWhittingham/agsadmin
SummaryArcGIS Server REST Admin API Proxy
upload_time2023-09-01 07:34:00
maintainer
docs_urlNone
authorDavid Whittingham; Adam Kerz; Daniel Baternik
requires_python
licenseBSD 3-Clause
keywords arcgis esri
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ========
agsadmin
========

agsadmin provides a convenient Python front-end to several REST calls on the ArcGIS Server 10.1+ REST Admin API.

Features
========

ArcGIS Server (RestAdmin)
*************************

- Services (Map/Image/Geoprocessing/Geometry/Geocode/GeoData/Globe/Search)

  - start and stop
  - get statistics
  - get status
  - get or set the item info (description, summary, tags, etc.)
  - set service properties
  - rename services
  
- Machines

  - start and stop

- System

  - Directories

    - list directories
    - register new directories
    - unregister directories
    - clean directories

- Uploads

  - list uploads
  - get a specific upload item
  - upload a file

These functions can be used to automate management of ArcGIS Services (e.g. start/stop services on a schedule, 
start/stop services to perform maintenance on associated datasets, etc.)

ArcGIS Portal (SharingAdmin)
****************************

- Content

  - get item
  - add/get/move/delete/update user item
  - get user/folder content

- Community

  - get user
  - get group
  - create group
  - update group


Example
=======
The following is a simplistic example to stop and start a map service.

.. code-block:: python

  import agsadmin

  hostname = "<ServerNameHere>"
  username = "<UsernameHere>"
  password = "<PasswordHere>"

  rest_admin = agsadmin.RestAdmin(hostname, username, password)
  service = rest_admin.services.get_service("<MapServiceNameHere>", "MapServer", "<OptionalFolderHere>")
  service.stop_service()
  service.start_service()
  service.delete()

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/DavidWhittingham/agsadmin",
    "name": "agsadmin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "arcgis esri",
    "author": "David Whittingham; Adam Kerz; Daniel Baternik",
    "author_email": "",
    "download_url": "",
    "platform": null,
    "description": "========\r\nagsadmin\r\n========\r\n\r\nagsadmin provides a convenient Python front-end to several REST calls on the ArcGIS Server 10.1+ REST Admin API.\r\n\r\nFeatures\r\n========\r\n\r\nArcGIS Server (RestAdmin)\r\n*************************\r\n\r\n- Services (Map/Image/Geoprocessing/Geometry/Geocode/GeoData/Globe/Search)\r\n\r\n  - start and stop\r\n  - get statistics\r\n  - get status\r\n  - get or set the item info (description, summary, tags, etc.)\r\n  - set service properties\r\n  - rename services\r\n  \r\n- Machines\r\n\r\n  - start and stop\r\n\r\n- System\r\n\r\n  - Directories\r\n\r\n    - list directories\r\n    - register new directories\r\n    - unregister directories\r\n    - clean directories\r\n\r\n- Uploads\r\n\r\n  - list uploads\r\n  - get a specific upload item\r\n  - upload a file\r\n\r\nThese functions can be used to automate management of ArcGIS Services (e.g. start/stop services on a schedule, \r\nstart/stop services to perform maintenance on associated datasets, etc.)\r\n\r\nArcGIS Portal (SharingAdmin)\r\n****************************\r\n\r\n- Content\r\n\r\n  - get item\r\n  - add/get/move/delete/update user item\r\n  - get user/folder content\r\n\r\n- Community\r\n\r\n  - get user\r\n  - get group\r\n  - create group\r\n  - update group\r\n\r\n\r\nExample\r\n=======\r\nThe following is a simplistic example to stop and start a map service.\r\n\r\n.. code-block:: python\r\n\r\n  import agsadmin\r\n\r\n  hostname = \"<ServerNameHere>\"\r\n  username = \"<UsernameHere>\"\r\n  password = \"<PasswordHere>\"\r\n\r\n  rest_admin = agsadmin.RestAdmin(hostname, username, password)\r\n  service = rest_admin.services.get_service(\"<MapServiceNameHere>\", \"MapServer\", \"<OptionalFolderHere>\")\r\n  service.stop_service()\r\n  service.start_service()\r\n  service.delete()\r\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause",
    "summary": "ArcGIS Server REST Admin API Proxy",
    "version": "0.5.3",
    "project_urls": {
        "Homepage": "https://github.com/DavidWhittingham/agsadmin"
    },
    "split_keywords": [
        "arcgis",
        "esri"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5ee9b453eca0d0997d5bc6915c6cbd74faf249c11dd025512c5dfd07c112f3d9",
                "md5": "93c1a3f3d080b02854d03663e7094300",
                "sha256": "7beff9713bc557dba20481b347a8043a77f0ef727a1ce62f65e29e45d014d000"
            },
            "downloads": -1,
            "filename": "agsadmin-0.5.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93c1a3f3d080b02854d03663e7094300",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 80627,
            "upload_time": "2023-09-01T07:34:00",
            "upload_time_iso_8601": "2023-09-01T07:34:00.891672Z",
            "url": "https://files.pythonhosted.org/packages/5e/e9/b453eca0d0997d5bc6915c6cbd74faf249c11dd025512c5dfd07c112f3d9/agsadmin-0.5.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-01 07:34:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DavidWhittingham",
    "github_project": "agsadmin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "agsadmin"
}
        
Elapsed time: 0.11815s