chore: rename

This commit is contained in:
J. Nick Koston 2022-09-09 08:44:30 -05:00
parent 9e7ecc7876
commit 7e9609b0f5
7 changed files with 30 additions and 31 deletions

View File

@ -30,7 +30,7 @@
<img src="https://img.shields.io/pypi/l/dbus-fast.svg?style=flat-square" alt="License">
</p>
A faster version of dbus-next original from the great next great DBus library for Python library
A faster version of dbus-fast original from the great next great DBus library for Python library
## Installation
@ -48,14 +48,14 @@ Desktop users can use this library to create their own scripts and utilities to
dbus-fast plans to improve over other DBus libraries for Python in the following ways:
* Zero dependencies and pure Python 3.
* Focus on performance
* Support for multiple IO backends including asyncio and the GLib main loop.
* Nonblocking IO suitable for GUI development.
* Target the latest language features of Python for beautiful services and clients.
* Complete implementation of the DBus type system without ever guessing types.
* Integration tests for all features of the library.
* Completely documented public API.
- Zero dependencies and pure Python 3.
- Focus on performance
- Support for multiple IO backends including asyncio and the GLib main loop.
- Nonblocking IO suitable for GUI development.
- Target the latest language features of Python for beautiful services and clients.
- Complete implementation of the DBus type system without ever guessing types.
- Integration tests for all features of the library.
- Completely documented public API.
## Installing
@ -115,7 +115,7 @@ loop.run_until_complete(main())
To define a service on the bus, use the `ServiceInterface` class and decorate class methods to specify DBus methods, properties, and signals with their type signatures.
For more information, see the [overview for the high-level service](https://python-dbus-next.readthedocs.io/en/latest/high-level-service/index.html).
For more information, see the [overview for the high-level service](https://python-dbus-fast.readthedocs.io/en/latest/high-level-service/index.html).
```python
from dbus_next.service import ServiceInterface, method, dbus_property, signal, Variant
@ -168,7 +168,7 @@ asyncio.get_event_loop().run_until_complete(main())
The low-level interface works with DBus messages directly.
For more information, see the [overview for the low-level interface](https://python-dbus-next.readthedocs.io/en/latest/low-level-interface/index.html).
For more information, see the [overview for the low-level interface](https://python-dbus-fast.readthedocs.io/en/latest/low-level-interface/index.html).
```python
from dbus_next.message import Message, MessageType
@ -198,14 +198,14 @@ async def main():
loop.run_until_complete(main())
```
## Projects that use python-dbus-next
## Projects that use python-dbus-fast
* The [Playerctl](https://github.com/altdesktop/playerctl) test suite
* [i3-dstatus](https://github.com/altdesktop/i3-dstatus)
- The [Playerctl](https://github.com/altdesktop/playerctl) test suite
- [i3-dstatus](https://github.com/altdesktop/i3-dstatus)
## Contributing
Contributions are welcome. Development happens on [Github](https://github.com/altdesktop/python-dbus-next).
Contributions are welcome. Development happens on [Github](https://github.com/altdesktop/python-dbus-fast).
Before you commit, run `make` to run the linter, code formatter, and the test suite.
@ -216,7 +216,6 @@ You can use this code under an MIT license (see LICENSE).
© 2019, Tony Crisci
© 2019, Tony Crisci
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

View File

@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = dbus-next
SPHINXPROJ = dbus-fast
SOURCEDIR = .
BUILDDIR = _build

View File

@ -105,7 +105,7 @@ html_static_path = ["_static"]
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = "dbus-nextdoc"
htmlhelp_basename = "dbus-fastdoc"
# -- Options for LaTeX output ------------------------------------------------
@ -128,14 +128,14 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, "dbus-next.tex", "dbus-next Documentation", __author__, "manual"),
(master_doc, "dbus-fast.tex", "dbus-fast Documentation", __author__, "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, _project_slug, "dbus-next Documentation", [author], 1)]
man_pages = [(master_doc, _project_slug, "dbus-fast Documentation", [author], 1)]
# -- Options for Texinfo output ----------------------------------------------
@ -146,7 +146,7 @@ texinfo_documents = [
(
master_doc,
_project_slug,
"dbus-next Documentation",
"dbus-fast Documentation",
author,
_project_slug,
"One line description of project.",

View File

@ -46,21 +46,21 @@ The library offers three core interfaces:
Installation
++++++++++++
This library is available on PyPi as `dbus-next <https://pypi.org/project/dbus-next/>`_.
This library is available on PyPi as `dbus-fast <https://pypi.org/project/dbus-fast/>`_.
.. code-block:: bash
pip3 install dbus-next
pip3 install dbus-fast
Contributing
++++++++++++
Development for this library happens on `Github <https://github.com/altdesktop/python-dbus-next>`_. Report bugs or request features there. Contributions are welcome.
Development for this library happens on `Github <https://github.com/altdesktop/python-dbus-fast>`_. Report bugs or request features there. Contributions are welcome.
License
++++++++
This library is available under an `MIT License <https://github.com/altdesktop/python-dbus-next/blob/master/LICENSE>`_.
This library is available under an `MIT License <https://github.com/altdesktop/python-dbus-fast/blob/master/LICENSE>`_.
© 2019, Tony Crisci

View File

@ -1,6 +1,6 @@
__title__ = "dbus_next"
__description__ = "A zero-dependency DBus library for Python with asyncio support"
__url__ = "https://github.com/altdesktop/python-dbus-next"
__url__ = "https://github.com/altdesktop/python-dbus-fast"
__version__ = "0.2.3"
__author__ = "Tony Crisci"
__author_email__ = "tony@dubstepdish.com"

View File

@ -541,7 +541,7 @@ class BaseMessageBus:
if path is None:
raise Exception(
"Could not find interface on bus (this is a bug in dbus-next)"
"Could not find interface on bus (this is a bug in dbus-fast)"
)
self.send(

View File

@ -60,9 +60,9 @@ def method(name: str = None, disabled: bool = False):
This class method will be called when a client calls the method on the DBus
interface. The parameters given to the function come from the calling
client and will conform to the dbus-next type system. The parameters
client and will conform to the dbus-fast type system. The parameters
returned will be returned to the calling client and must conform to the
dbus-next type system. If multiple parameters are returned, they must be
dbus-fast type system. If multiple parameters are returned, they must be
contained within a :class:`list`.
The decorated method may raise a :class:`DBusError <dbus_next.DBusError>`
@ -138,7 +138,7 @@ def signal(name: str = None, disabled: bool = False):
If the signal has an out argument, the class method must have a return type
annotation with a signature string of a single complete DBus type and the
return value of the class method must conform to the dbus-next type system.
return value of the class method must conform to the dbus-fast type system.
If the signal has multiple out arguments, they must be returned within a
``list``.
@ -269,7 +269,7 @@ def dbus_property(
interface, the setter will be called with the value from the calling
client.
The parameters of the getter and the setter must conform to the dbus-next
The parameters of the getter and the setter must conform to the dbus-fast
type system. The getter or the setter may raise a :class:`DBusError
<dbus_next.DBusError>` to return an error to the client.