{"id":18798742,"url":"https://github.com/f5networks/f5-icontrol-rest-python","last_synced_at":"2025-04-09T09:08:40.445Z","repository":{"id":57428041,"uuid":"44190278","full_name":"F5Networks/f5-icontrol-rest-python","owner":"F5Networks","description":"Generic python library used by the F5 SDK and other F5 projects to communicate with BIG-IP® via the REST API","archived":false,"fork":false,"pushed_at":"2024-04-08T10:21:37.000Z","size":238,"stargazers_count":38,"open_issues_count":2,"forks_count":33,"subscribers_count":27,"default_branch":"1.0","last_synced_at":"2025-04-02T06:07:28.610Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://icontrol.readthedocs.org/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/F5Networks.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-13T16:37:07.000Z","updated_at":"2025-02-02T20:21:47.000Z","dependencies_parsed_at":"2024-06-18T18:23:48.926Z","dependency_job_id":"08c17d3b-eb9d-4173-9641-6a4d367153b6","html_url":"https://github.com/F5Networks/f5-icontrol-rest-python","commit_stats":{"total_commits":147,"total_committers":23,"mean_commits":6.391304347826087,"dds":0.7619047619047619,"last_synced_commit":"c70eade07bec68c3a59da9fe98442e55d3731996"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-icontrol-rest-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-icontrol-rest-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-icontrol-rest-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-icontrol-rest-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/F5Networks","download_url":"https://codeload.github.com/F5Networks/f5-icontrol-rest-python/tar.gz/refs/heads/1.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248008630,"owners_count":21032556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T22:12:51.512Z","updated_at":"2025-04-09T09:08:40.425Z","avatar_url":"https://github.com/F5Networks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"f5-icontrol-rest-python\n=======================\n\n**Note this repo is archived and is no longer maintained.**\n\n|Build Status| |Documentation Status| |slack badge|\n\nIntroduction\n------------\n\nThis generic python library allows programs and other modules to\ninteract with the BIG-IP® iControl® REST API.\n\n**If you want to use python to automate BIG-IP® devices via the REST API, use the  F5 SDK** (`F5Networks/f5-common-python \u003chttps://github.com/F5Networks/f5-common-python\u003e`_).\n\nInstallation\n------------\n\nUsing Pip\n`````````\n\n.. code:: bash\n\n    $ pip install f5-icontrol-rest\n\n\nInstalling directly from GitHub\n```````````````````````````````\n\n**NOTE:** The example below installs the package at release v0.1.0. Omitting the version number will install the package from the current state of the default branch.\n\n.. code:: shell\n\n    $ pip install git+ssh://git@github.com/F5Networks/f5-icontrol-rest@v0.1.0`\n\n\nConfiguration\n-------------\nN/A\n\nUsage\n-----\n\n.. code:: python\n\n    from icontrol.session import iControlRESTSession\n    icr_session = iControlRESTSession('myuser', 'mypass')\n    icr_session.get(\n        'https://bigip.example.com/mgmt/tm/ltm/nat',\n        name='mynat',\n        partition='Common')\n\n\nDocumentation\n-------------\n\nSee `Documentation \u003chttp://icontrol.readthedocs.org\u003e`_.\n\nFor Developers:\n---------------\n\nFiling Issues\n`````````````\n\nIf you find an issue we would love to hear about it. Please let us know\nby filing an issue in this repository and tell us as much as you can\nabout what you found and how you found it.\n\nContributing\n````````````\n\nSee `Contributing \u003cCONTRIBUTING.md\u003e`_.\n\nBuild\n`````\n\nTo make a PyPI package:\n\n.. code:: bash\n\n    $ python setup.py sdist\n\n\nTest\n````\nBefore you open a pull request, your code must have passing `pytest \u003chttp://pytest.org\u003e`__ unit tests. In addition, you should include a set of functional tests written to use a real BIG-IP® for testing. Information on how to run our set of tests is included below.\n\nUnit Tests\n~~~~~~~~~~\n\nWe use pytest for our unit tests.\n\n1. If you haven't already, install the required test packages listed in requirements.test.txt in your virtual\nenvironment.\n\n.. code:: shell\n\n    $ pip install -r requirements.test.txt\n\n\n2. Run the tests and produce a coverage report. The ``--cov-report=html``\n   will create a ``htmlcov/`` directory that you can view in your browser to see the missing lines of code.\n\n.. code:: shell\n\n   $ py.test --cov ./icontrol --cov-report=html\n   $ open htmlcov/index.html\n\n\nStyle Checks\n~~~~~~~~~~~~\nWe use the hacking module for our style checks (installed as part of\nstep 1 in the Unit Test section).\n\n.. code:: shell\n\n    $ flake8 ./\n\nCopyright\n---------\nCopyright 2015-2016 F5 Networks Inc.\n\nSupport\n-------\nSee `Support \u003cSUPPORT.md\u003e`_.\n\nLicense\n-------\n\nApache V2.0\n```````````\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may\nnot use this file except in compliance with the License. You may obtain\na copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\nContributor License Agreement\n`````````````````````````````\nIndividuals or business entities who contribute to this project must have completed and submitted the `F5 Contributor License Agreement \u003chttp://f5-openstack-docs.readthedocs.org/en/latest/cla_landing.html\u003e`__ to Openstack\\_CLA@f5.com prior to their code submission being included in this project.\n\n\n.. |Build Status| image:: https://travis-ci.org/F5Networks/f5-icontrol-rest-python.svg?branch=develop\n    :target: https://travis-ci.org/F5Networks/f5-icontrol-rest-python\n.. |Documentation Status| image:: https://readthedocs.org/projects/icontrol/badge/?version=latest\n   :target: http://icontrol.readthedocs.org/en/latest/?badge=latest\n.. |slack badge| image:: https://f5-openstack-slack.herokuapp.com/badge.svg\n    :target: https://f5-openstack-slack.herokuapp.com/\n    :alt: Slack\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-icontrol-rest-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff5networks%2Ff5-icontrol-rest-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-icontrol-rest-python/lists"}