{"id":13468224,"url":"https://github.com/arskom/spyne","last_synced_at":"2025-05-14T07:11:10.157Z","repository":{"id":949655,"uuid":"792753","full_name":"arskom/spyne","owner":"arskom","description":"A transport agnostic sync/async RPC library that focuses on exposing services with a well-defined API using popular protocols.","archived":false,"fork":false,"pushed_at":"2024-05-01T23:32:11.000Z","size":12349,"stargazers_count":1139,"open_issues_count":83,"forks_count":317,"subscribers_count":40,"default_branch":"master","last_synced_at":"2025-04-11T02:51:53.872Z","etag":null,"topics":["api","api-rest","api-server","http","json","msgpack","python","rpc","rpc-framework","soap","twisted"],"latest_commit_sha":null,"homepage":"http://spyne.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arskom.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2010-07-23T06:26:28.000Z","updated_at":"2025-04-06T13:07:06.000Z","dependencies_parsed_at":"2024-06-12T21:01:57.589Z","dependency_job_id":null,"html_url":"https://github.com/arskom/spyne","commit_stats":{"total_commits":6433,"total_committers":129,"mean_commits":49.86821705426357,"dds":"0.23053007927871916","last_synced_commit":"daf2f662c76c66b53ffbd965c4e5431e650003e8"},"previous_names":[],"tags_count":98,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arskom%2Fspyne","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arskom%2Fspyne/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arskom%2Fspyne/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arskom%2Fspyne/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arskom","download_url":"https://codeload.github.com/arskom/spyne/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092798,"owners_count":22013292,"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":["api","api-rest","api-server","http","json","msgpack","python","rpc","rpc-framework","soap","twisted"],"created_at":"2024-07-31T15:01:07.290Z","updated_at":"2025-05-14T07:11:05.133Z","avatar_url":"https://github.com/arskom.png","language":"Python","readme":"If you like and use Spyne, star it on `Github \u003chttps://github.com/arskom/spyne\u003e`_!\n\nAbout\n=====\n\nSpyne aims to save the protocol implementers the hassle of implementing their\nown remote procedure call api and the application programmers the hassle of\njumping through hoops just to expose their services using multiple protocols and\ntransports.\n\nIn other words, Spyne is a framework for building distributed\nsolutions that strictly follow the MVC pattern, where Model = `spyne.model`,\nView = `spyne.protocol` and Controller = `user code`.\n\nSpyne comes with the implementations of popular transport, protocol and\ninterface document standards along with a well-defined API that lets you\nbuild on existing functionality.\n\nThe following are the primary sources of information about spyne:\n\n* Spyne's home page is: http://spyne.io/\n* The latest documentation for all releases of Spyne can be found at: http://spyne.io/docs\n* The official source code repository is at: https://github.com/arskom/spyne\n* The official spyne discussion forum is at: people at spyne dot io. Subscribe\n  either via http://lists.spyne.io/listinfo/people or by sending an empty\n  message to: people-subscribe at spyne dot io.\n* You can download Spyne releases from\n  `Github \u003chttps://github.com/arskom/spyne/downloads\u003e`_ or\n  `PyPi \u003chttp://pypi.python.org/pypi/spyne\u003e`_.\n* Continuous Integration: https://jenkins.arskom.com.tr/job/spyne/\n\nRequirements\n============\n\nSpyne source distribution is a collection of highly decoupled components, which\nmakes it a bit difficult to put a simple list of requirements, as literally\neverything except ``pytz`` is optional.\n\nPython version\n--------------\n\nSpyne 2.13 supports Python 2.7, 3.6, 3.7, 3.8, 3.9 and 3.10.\n\nLibraries\n---------\n\nAdditionally the following software packages are needed for various subsystems\nof Spyne:\n\n* A Wsgi server of your choice is needed to wrap\n  ``spyne.server.wsgi.WsgiApplication``\n* `lxml\u003e=3.2.5 \u003chttp://lxml.de\u003e`_ is needed for any xml-related protocol.\n* `lxml\u003e=3.4.1 \u003chttp://lxml.de\u003e`_ is needed for any html-related protocol.\n* `SQLAlchemy \u003chttp://sqlalchemy.org\u003e`_ is needed for\n  ``spyne.model.complex.TTableModel``.\n* `pyzmq \u003chttps://github.com/zeromq/pyzmq\u003e`_ is needed for\n  ``spyne.client.zeromq.ZeroMQClient`` and\n  ``spyne.server.zeromq.ZeroMQServer``.\n* `Werkzeug \u003chttp://werkzeug.pocoo.org/\u003e`_ is needed for using\n  ``spyne.protocol.http.HttpRpc`` under a wsgi transport.\n* `PyParsing \u003chttp://pypi.python.org/pypi/pyparsing\u003e`_ is needed for\n  using ``HttpPattern``'s with ``spyne.protocol.http.HttpRpc``\\.\n* `Twisted \u003chttp://twistedmatrix.com/\u003e`_ is needed for anything in\n  ``spyne.server.twisted`` and ``spyne.client.twisted``.\n* `Django \u003chttp://djangoproject.com/\u003e`_ (tested with 1.8 and up) is needed for\n  anything in ``spyne.server.django``.\n* `Pyramid \u003chttp://pylonsproject.org/\u003e`_ is needed for\n  ``spyne.server.pyramid.PyramidApplication``.\n* `msgpack\u003e=1.0.0 \u003chttp://github.com/msgpack/msgpack-python/\u003e`_ is needed for\n  ``spyne.protocol.msgpack``.\n* `PyYaml \u003chttps://bitbucket.org/xi/pyyaml\u003e`_ is needed for\n  ``spyne.protocol.yaml``.\n* `simplejson \u003chttp://github.com/simplejson/simplejson\u003e`_ is used when found\n  for ``spyne.protocol.json``.\n\nYou are advised to add these as requirements to your own projects, as these are\nonly optional dependencies of Spyne, thus not handled in its setup script.\n\nInstalling\n==========\n\nYou first need to have package manager (pip, easy_install) installed. Spyne\nships with a setuptools bootstrapper, so if setup.py refuses to run because it\ncan't find setuptools, do:\n\n    bin/distribute_setup.py\n\nYou can add append --user to get it installed with $HOME/.local as prefix.\n\nYou can get spyne via pypi: ::\n\n    easy_install [--user] spyne\n\nor you can clone the latest master tree from Github: ::\n\n    git clone git://github.com/arskom/spyne.git\n\nTo install from source distribution, you can run the setup script as usual: ::\n\n    python setup.py install [--user]\n\nIf you want to make any changes to the Spyne code, just use ::\n\n    python setup.py develop [--user]\n\nso that you can painlessly test your patches.\n\nFinally, to run the tests, you need to first install every single library that\nSpyne integrates with, along with additional packages like ``pytest`` or ``tox``\nthat are only needed when running Spyne testsuite. An up-to-date list is\nmaintained in the ``requirements/`` directory, in separate files for both\nPython 2.7 and \u003e=3.6. To install everything, run: ::\n\n    pip install [--user] -r requirements/test_requirements.txt\n\nIf you are still stuck on Python 2.x however, you should use: ::\n\n    pip install [--user] -r requirements/test_requirements_py27.txt\n\nAssuming all dependencies are installed without any issues, the following\ncommand will run the whole test suite: ::\n\n    python setup.py test\n\nSpyne's test harness has evolved a lot in the 10+ years the project has been\nactive. It has 3 main stages: Traditional unit tests, tests that perform\nend-to-end testing by starting actual daemons that listen on real TCP sockets\non hard-coded ports, and finally Django tests that are managed by tox. Naively\nrunning pytest etc in the root directory will fail as their auto-discovery\nmechanism was not implemented with Spyne's requirements in mind.\n\nGetting Support\n===============\n\nOfficial support channels are as follows:\n\n- The official mailing list for both users and developers alike can be found at:\n  http://lists.spyne.io/listinfo/people.\n\n- You can use the 'spyne' tag to ask questions on\n  `Stack Overflow \u003chttps://stackoverflow.com/questions/tagged/spyne\u003e`_.\n\n- You can also use the `forum \u003chttps://github.com/arskom/spyne/discussions\u003e`_ on\n  the project's github page.\n\nPlease don't use the issue tracker for asking questions. It's a database that\nholds the most important information for the project, so we must avoid\ncluttering it as much as possible.\n\nContributing\n============\n\nIf you feel like helping out, see the CONTRIBUTING.rst file in the Spyne source\ndistribution for starting points and general guidelines.\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farskom%2Fspyne","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farskom%2Fspyne","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farskom%2Fspyne/lists"}