All Projects → DaveTCode → Confluence Python Lib

DaveTCode / Confluence Python Lib

Licence: mit
A python library wrapping the Confluence REST API

Programming Languages

python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to Confluence Python Lib

Restheart
RESTHeart - The REST API for MongoDB
Stars: ✭ 659 (+2096.67%)
Mutual labels:  rest-api, rest
Ngx Restangular
Restangular for Angular 2 and higher versions
Stars: ✭ 787 (+2523.33%)
Mutual labels:  rest-api, rest
Rest Api Nodejs Mongodb
A boilerplate for REST API Development with Node.js, Express, and MongoDB
Stars: ✭ 672 (+2140%)
Mutual labels:  rest-api, rest
Spyke
Interact with REST services in an ActiveRecord-like manner
Stars: ✭ 591 (+1870%)
Mutual labels:  rest-api, rest
Farwest
Framework for building RESTful HATEOAS-driven applications.
Stars: ✭ 18 (-40%)
Mutual labels:  rest-api, rest
Rest Assured
Java DSL for easy testing of REST services
Stars: ✭ 5,646 (+18720%)
Mutual labels:  rest-api, rest
Apidoc
RESTful API 文档生成工具,支持 Go、Java、Swift、JavaScript、Rust、PHP、Python、Typescript、Kotlin 和 Ruby 等大部分语言。
Stars: ✭ 785 (+2516.67%)
Mutual labels:  rest-api, rest
Cerberus
A demonstration of a completely stateless and RESTful token-based authorization system using JSON Web Tokens (JWT) and Spring Security.
Stars: ✭ 482 (+1506.67%)
Mutual labels:  rest-api, rest
Liberator
An Elixir library for building RESTful applications.
Stars: ✭ 28 (-6.67%)
Mutual labels:  rest-api, rest
Gen
Converts a database into gorm structs and RESTful api
Stars: ✭ 825 (+2650%)
Mutual labels:  rest-api, rest
Restful Api Design References
RESTful API 设计参考文献列表,可帮助你更加彻底的了解REST风格的接口设计。
Stars: ✭ 4,830 (+16000%)
Mutual labels:  rest-api, rest
Rest Api Examples
Test and Prototype with Fake Online REST/OAuth 2 APIs Examples
Stars: ✭ 13 (-56.67%)
Mutual labels:  rest-api, rest
Modular Monolith With Ddd
Full Modular Monolith application with Domain-Driven Design approach.
Stars: ✭ 6,210 (+20600%)
Mutual labels:  rest-api, rest
Rest Api Design Guide
NBB's REST-ish API Design Guide
Stars: ✭ 643 (+2043.33%)
Mutual labels:  rest-api, rest
Networking
⚡️ Elegantly connect to a REST JSON Api. URLSession + Combine + Decodable + Generics = <3
Stars: ✭ 499 (+1563.33%)
Mutual labels:  rest-api, rest
Restclient
🦄 Simple HTTP and REST client for Unity based on Promises, also supports Callbacks! 🎮
Stars: ✭ 675 (+2150%)
Mutual labels:  rest-api, rest
Swagger Ui
Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
Stars: ✭ 21,279 (+70830%)
Mutual labels:  rest-api, rest
Swagger Parser
Swagger Spec to Java POJOs
Stars: ✭ 468 (+1460%)
Mutual labels:  rest-api, rest
Scala Pet Store
An implementation of the java pet store using FP techniques in scala
Stars: ✭ 812 (+2606.67%)
Mutual labels:  rest-api, rest
Swagger Core
Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
Stars: ✭ 6,898 (+22893.33%)
Mutual labels:  rest-api, rest

|Build Status| |PyPI version| |codecov| |Requirements Status| |Docs|

Confluence Python Library

This is a simple wrapper around the REST API which the Confluence provides. Consider the API to be stable as of v1.0.0 (now released)

c.f. endpoints.md_ for a list of endpoints and whether this library supports them yet. Please do send pull requests if you want an endpoint that isn’t covered!

Installation

::

pip install confluence-rest-library

Usage

.. code:: python

from confluence.client import Confluence
with Confluence('https://site:8080/confluence', ('user', 'pass')) as c:
    pages = c.search('ID=1')

Development and Deployment

See the Contribution guidelines for this project_ for details on how to make changes to this library.

Testing Locally


There are two sets of tests included. A suite of unit tests that verify the
models can be built correctly and a suite of integration tests that run against
a local instance of confluence. The unit tests can be run by simply invoking:
.. code::

    python setup.py test --addopts "tests"

The integration tests are more complex and require the developer to take the following steps:

- Install the `Atlassian SDK <https://developer.atlassian.com/server/framework/atlassian-sdk/set-up-the-atlassian-plugin-sdk-and-build-a-project/>`_
- Run ``atlas-run-standalone --product confluence --version 6.6.0 --server localhost``
- Wait for the server to complete starting up
- Run integration tests using ``python setup.py test --addopts "integration_tests"``

.. _endpoints.md: endpoints.md
.. _Contribution guidelines for this project: CONTRIBUTING.rst

.. |Build Status| image:: https://travis-ci.org/DaveTCode/confluence-python-lib.svg?branch=master
   :target: https://travis-ci.org/DaveTCode/confluence-python-lib
   :alt: Build status
.. |PyPI version| image:: https://badge.fury.io/py/confluence-rest-library.svg
   :target: https://badge.fury.io/py/confluence-rest-library
   :alt: PyPI version
.. |codecov| image:: https://codecov.io/gh/DaveTCode/confluence-python-lib/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/DaveTCode/confluence-python-lib
   :alt: Code coverage stats
.. |Requirements Status| image:: https://requires.io/github/DaveTCode/confluence-python-lib/requirements.svg?branch=master
   :target: https://requires.io/github/DaveTCode/confluence-python-lib/requirements/?branch=master
   :alt: Requirements status
.. |Docs| image:: https://readthedocs.org/projects/confluence-python-lib/badge/?version=latest
   :target: http://confluence-python-lib.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation status
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].