pyjabber 0.1.0__tar.gz

pyjabber-0.1.0/AUTHORS.rst

@@ -0,0 +1,9 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Aarón Raya <aaron.raya.lopez@gmail.com>
+

pyjabber-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,137 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/dinothor/pyjabber/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+PyJabber could always use more documentation, whether as part of the
+official PyJabber docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/dinothor/pyjabber/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `pyjabber` for local development.
+
+1. Fork the `pyjabber` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/pyjabber.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv pyjabber
+    $ cd pyjabber/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ make lint
+    $ make test
+    Or
+    $ make test-all
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
+   https://travis-ci.com/dinothor/pyjabber/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+
+    $ python -m unittest tests.test_pyjabber
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.
+
+Code of Conduct
+---------------
+
+Please note that this project is released with a `Contributor Code of Conduct`_.
+By participating in this project you agree to abide by its terms.
+
+.. _`Contributor Code of Conduct`: CODE_OF_CONDUCT.rst

pyjabber-0.1.0/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2024-04-18)
+------------------
+
+* First release on PyPI.

pyjabber-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, Aarón Raya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

pyjabber-0.1.0/MANIFEST.in

@@ -0,0 +1,15 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+include pyjabber/db/schema.sql
+include pyjabber/stream/schemas/schemas.pkl
+recursive-include pyjabber/webpage/build *
+recursive-include pyjabber/network/certs *
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

pyjabber-0.1.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.1
+Name: pyjabber
+Version: 0.1.0
+Summary: A Python XMPP server
+Home-page: https://github.com/DinoThor/PyJabber
+Author: Aarón Raya  
+Author-email: aaron.raya.lopez@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: aiohttp==3.9.5
+Requires-Dist: loguru==0.7.2
+Requires-Dist: xmlschema==3.3.0
+
+========
+PyJabber
+========
+
+
+.. image:: https://img.shields.io/pypi/v/pyjabber.svg
+        :target: https://test.pypi.org/project/pyjabber/
+
+.. image:: https://img.shields.io/travis/dinothor/pyjabber.svg
+        :target: https://travis-ci.com/dinothor/pyjabber
+
+.. image:: https://readthedocs.org/projects/pyjabber/badge/?version=latest
+        :target: https://pyjabber.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+
+|         
+| PyJabber is a server for Jabber/XMPP entirely written in Python, with minimal reliance on external libraries. 
+| It strives to provide a simple, lightweight, and comprehensible codebase, featuring a modular structure that 
+        facilitates extension through the implementation of necessary XEPs for specific use cases. 
+| While initially designed to fulfill the requirements of the multi-agent system `SPADE <https://github.com/javipalanca/spade>`_, it can be easily customized to suit any other purpose.
+|
+
+* Free software: MIT license
+* Documentation: https://pyjabber.readthedocs.io.
+
+Installation
+------------
+.. code-block::
+  
+        pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pyjabber
+
+Quick start
+-----------
+.. code-block:: python
+        
+        from pyjabber import Server
+
+        my_server = Server()
+        my_server.start()
+
+.. code-block:: python
+
+        class Server(
+            host                : str = "localhost",
+            client_port         : int = 5222,
+            server_port         : int = 5223,
+            connection_timeout  : int = 60
+        )
+
+A formated logger can be added, in order to retrive the messages from the INFO, DEBUG and ERROR levels
+
+.. code-block:: python
+    
+    2024-05-03 11:45:51.229 | INFO     | pyjabber.server:run_server:52 - Starting server...
+    2024-05-03 11:45:51.231 | INFO     | pyjabber.server:run_server:73 - Server is listening clients on ('127.0.0.1', 5222)
+    2024-05-03 11:45:51.231 | INFO     | pyjabber.server:run_server:75 - Server started...
+
+
+
+
+Features
+--------
+
+.. list-table::
+   :widths: 25 25 50
+   :header-rows: 1
+
+   * - 
+     - Status
+     - Description
+   * - TLS
+     - Implemented
+     - v1.2, with localhost certificate included
+   * - SASL
+     - Implemented
+     - PLAIN
+   * - Roster
+     - Implemented
+     - CRUD avaliable
+   * - Presence
+     - Not implemented
+     - Working on it
+
+Plugins
+-------
+.. list-table::
+   :widths: 25 25 50
+   :header-rows: 1
+
+   * - 
+     - Status
+     - Description
+   * - `XEP-0077 <https://xmpp.org/extensions/xep-0077.html>`_
+     - IMPLEMENTED
+     - 
+   * - `XEP-0199 <https://xmpp.org/extensions/xep-0199.html>`_
+     - IMPLEMENTED
+     - 

pyjabber-0.1.0/README.rst

@@ -0,0 +1,99 @@
+========
+PyJabber
+========
+
+
+.. image:: https://img.shields.io/pypi/v/pyjabber.svg
+        :target: https://test.pypi.org/project/pyjabber/
+
+.. image:: https://img.shields.io/travis/dinothor/pyjabber.svg
+        :target: https://travis-ci.com/dinothor/pyjabber
+
+.. image:: https://readthedocs.org/projects/pyjabber/badge/?version=latest
+        :target: https://pyjabber.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+
+|         
+| PyJabber is a server for Jabber/XMPP entirely written in Python, with minimal reliance on external libraries. 
+| It strives to provide a simple, lightweight, and comprehensible codebase, featuring a modular structure that 
+        facilitates extension through the implementation of necessary XEPs for specific use cases. 
+| While initially designed to fulfill the requirements of the multi-agent system `SPADE <https://github.com/javipalanca/spade>`_, it can be easily customized to suit any other purpose.
+|
+
+* Free software: MIT license
+* Documentation: https://pyjabber.readthedocs.io.
+
+Installation
+------------
+.. code-block::
+  
+        pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pyjabber
+
+Quick start
+-----------
+.. code-block:: python
+        
+        from pyjabber import Server
+
+        my_server = Server()
+        my_server.start()
+
+.. code-block:: python
+
+        class Server(
+            host                : str = "localhost",
+            client_port         : int = 5222,
+            server_port         : int = 5223,
+            connection_timeout  : int = 60
+        )
+
+A formated logger can be added, in order to retrive the messages from the INFO, DEBUG and ERROR levels
+
+.. code-block:: python
+    
+    2024-05-03 11:45:51.229 | INFO     | pyjabber.server:run_server:52 - Starting server...
+    2024-05-03 11:45:51.231 | INFO     | pyjabber.server:run_server:73 - Server is listening clients on ('127.0.0.1', 5222)
+    2024-05-03 11:45:51.231 | INFO     | pyjabber.server:run_server:75 - Server started...
+
+
+
+
+Features
+--------
+
+.. list-table::
+   :widths: 25 25 50
+   :header-rows: 1
+
+   * - 
+     - Status
+     - Description
+   * - TLS
+     - Implemented
+     - v1.2, with localhost certificate included
+   * - SASL
+     - Implemented
+     - PLAIN
+   * - Roster
+     - Implemented
+     - CRUD avaliable
+   * - Presence
+     - Not implemented
+     - Working on it
+
+Plugins
+-------
+.. list-table::
+   :widths: 25 25 50
+   :header-rows: 1
+
+   * - 
+     - Status
+     - Description
+   * - `XEP-0077 <https://xmpp.org/extensions/xep-0077.html>`_
+     - IMPLEMENTED
+     - 
+   * - `XEP-0199 <https://xmpp.org/extensions/xep-0199.html>`_
+     - IMPLEMENTED
+     - 

pyjabber-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python3 -msphinx
+SPHINXPROJ    = pyjabber
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pyjabber-0.1.0/docs/architecture.rst

@@ -0,0 +1,28 @@
+============
+Architecture
+============
+
+.. image:: res/arch.png
+  :alt: Alternative text
+
+|
+| A PyJabber Server is builded by an asyncio loop, with an unique XMPPProtocol object instanced and asociated 
+    by each TCP conection made. 
+| An instance of Server will have an unique (Singleton) instance of a ConectionManager object. This will keep an unique list of Peers
+    conected to the server, and will be visible (but no modificable) for each XMPPProtocol instance.
+
+
+Client Stream
+-------------
+#. TCP connection: 
+    A client connects by host:5222. PyJabber will create an **XMPPProtocol** instance for this new connection, 
+    bound it and store it in the **ConectionManager** singleton
+#. Stream Negotiation: 
+    Client and PyJabber will start an XML message flow in order to stablish the session. 
+    This steep includes the process of securing the socket (startTLS), authentication/registration of the 
+    client and its resource binding. This step will be managed by the **StreamHandler**.
+#. Stanza Management: 
+    After the stream has been negotiated, a session will be started between 
+    server and client, and stanzas will be treated by the **StanzaHandler**. This stage is where the mayority 
+    of the application will be, and stanzas of **IQ**, **PRESENCE** and **MESSAGE** are treated.
+    

pyjabber-0.1.0/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst

pyjabber-0.1.0/docs/conf.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python
+#
+# pyjabber documentation build configuration file, created by
+# sphinx-quickstart on Fri Jun  9 13:47:02 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another
+# directory, add these directories to sys.path here. If the directory is
+# relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+import pyjabber
+
+# -- General configuration ---------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', "sphinx_wagtail_theme"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'PyJabber'
+copyright = "2024, Aarón Raya"
+author = "Aarón Raya"
+
+# The version info for the project you're documenting, acts as replacement
+# for |version| and |release|, also used in various other places throughout
+# the built documents.
+#
+# The short X.Y version.
+version = pyjabber.__version__
+# The full version, including alpha/beta/rc tags.
+release = pyjabber.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output -------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_wagtail_theme'
+
+# Theme options are theme-specific and customize the look and feel of a
+# theme further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = dict(
+    project_name = "PyJabber",
+)
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ---------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyjabberdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'pyjabber.tex',
+     'PyJabber Documentation',
+     'Aarón Raya', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pyjabber',
+     'PyJabber Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'pyjabber',
+     'PyJabber Documentation',
+     author,
+     'pyjabber',
+     'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

pyjabber-0.1.0/docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst

pyjabber-0.1.0/docs/history.rst

@@ -0,0 +1 @@
+.. include:: ../HISTORY.rst

pyjabber-0.1.0/docs/index.rst

@@ -0,0 +1,20 @@
+PyJabber
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   readme
+   installation
+   architecture
+   modules
+   contributing
+   authors
+   history
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`