Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
coolamqp
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
public
coolamqp
Commits
441ecc70
Commit
441ecc70
authored
8 years ago
by
Piotr Maślanka
Browse files
Options
Downloads
Patches
Plain Diff
started with docs
parent
9ec6a650
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
README.md
+3
-0
3 additions, 0 deletions
README.md
docs/conf.py
+6
-2
6 additions, 2 deletions
docs/conf.py
docs/index.rst
+1
-0
1 addition, 0 deletions
docs/index.rst
docs/tutorial.md
+28
-0
28 additions, 0 deletions
docs/tutorial.md
with
38 additions
and
2 deletions
README.md
+
3
−
0
View file @
441ecc70
CoolAMQP
========
[

](http://coolamqp.readthedocs.io/en/latest/?badge=latest)
[

](https://badge.fury.io/py/CoolAMQP)
[

](https://travis-ci.org/smok-serwis/coolamqp)
[

](https://codeclimate.com/github/smok-serwis/coolamqp)
...
...
@@ -10,6 +11,8 @@ CoolAMQP
A
**magical**
AMQP client, that uses
**heavy sorcery**
to achieve speeds that other AMQP clients cannot even hope to match.
Documentation (WIP) is available at
[
Read the Docs
](
http://coolamqp.readthedocs.io/
)
.
tl;dr -
[
this
](
coolamqp/framing/definitions.py
)
is
**machine-generated**
compile-time.
[
this
](
coolamqp/framing/compilation/content_property.py
)
**generates classes run-time**
,
and there are memoryviews
**_everywhere_**
.
...
...
This diff is collapsed.
Click to expand it.
docs/conf.py
+
6
−
2
View file @
441ecc70
...
...
@@ -19,7 +19,11 @@
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
from
recommonmark.parser
import
CommonMarkParser
source_parsers
=
{
'
.md
'
:
CommonMarkParser
}
# -- General configuration ------------------------------------------------
...
...
@@ -53,9 +57,9 @@ author = u'DMS Serwis s.c.'
# built documents.
#
# The short X.Y version.
version
=
u
'
0.9
series
'
version
=
'
0.
8
9
'
# The full version, including alpha/beta/rc tags.
release
=
u
'
0.
9 seri
es
'
release
=
u
'
0.
89-lat
es
t
'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
...
...
This diff is collapsed.
Click to expand it.
docs/index.rst
+
1
−
0
View file @
441ecc70
...
...
@@ -10,6 +10,7 @@ Welcome to CoolAMQP's documentation!
:maxdepth: 2
:caption: Contents:
tutorial
Indices and tables
...
...
This diff is collapsed.
Click to expand it.
docs/tutorial.md
0 → 100644
+
28
−
0
View file @
441ecc70
# Tutorial
If you want to connect to an AMQP broker, you need:
*
it's address (and port)
*
login and password
*
name of the virtual host
An idea of a heartbeat interval would be good, but you can do without. Since CoolAMQP will support clusters
in the future, you should define the nodes first. You can do it using _NodeDefinition_.
See NodeDefinition's documentation for alternative ways to do this, but here we will use
the AMQP connection string.
```
python
from
coolamqp.objects
import
NodeDefinition
node
=
NodeDefinition
(
'
amqp://user@password:host/vhost
'
)
```
_Cluster_
instances are used to interface with the cluster (or a single broker). It
accepts a list of nodes:
```
python
from
coolamqp.clustering
import
Cluster
cluster
=
Cluster
([
node
])
cluster
.
start
(
wait
=
True
)
```
_wait=True_
will block until connection is completed. After this, you can use other methods.
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment