pypertrail

Python wrapper library and CLI for papertrail API.

These details have not been verified by PyPI

Project links

Homepage

Project description

You can't use 'macro parameter character #' in math mode

export PAPERTRAIL_API_TOKEN=my_token

p y p e r t r a i l u s e r s l i s t V i a i m p l i c i t / . p y p e r t r a i l . y m l : . . c o d e :: b a s h

echo "token: my_token" > ~/.pypertrail.yml

p y p e r t r a i l u s e r s l i s t V i a (- - c o n f / - c) o p t i o n : . . c o d e :: b a s h

echo "token: my_token" > /path/to/config

p y p e r t r a i l - - c o n f / p a t h / t o / c o n f i g u s e r s l i s t V i a (- - t o k e n / - t) o p t i o n : . . c o d e :: b a s h

pypertrail --token my_token users list

Subcommands
~~~~~~~~~~~

.. code:: plain

Usage: pypertrail.py [OPTIONS] COMMAND [ARGS]...

Options:
-d, --debug Debug mode.
-p, --pretty Prettify JSON output.
-t, --token TEXT Papertrail API token.
-c, --conf TEXT Path to config (~/.pypertrail.yml).
--version Show the version and exit.
-h, --help Show this message and exit.

Commands:
accounts
archives
groups
saved_searches
search
systems
users

Accounts
~~~~~~~~

.. code:: plain

Usage: papertrail.py accounts [OPTIONS] COMMAND [ARGS]...

Options:
-h, --help Show this message and exit.

Commands:
list List account usage

Examples:

.. code:: bash

p y p e r t r a i l - - p r e t t y a c c o u n t s l i s t A r c h i v e s . . c o d e :: p l a i n U s a g e : p a p e r t r a i l . p y a r c h i v e s [O P T I O N S] C O M M A N D [A R G S] . . . O p t i o n s : - h, - - h e l p S h o w t h i s m e s s a g e a n d e x i t . C o m m a n d s : l i s t L i s t a r c h i v e i n f o r m a t i o n E x a m p l e s : . . c o d e :: b a s h

pypertrail --pretty archives list

Saved searches
~~~~~~~~~~~~~~

.. code:: plain

Usage: cli.py saved_searches [OPTIONS] COMMAND [ARGS]...

Options:
-h, --help Show this message and exit.

Commands:
create Create a saved search
delete Delete a saved search
list List saved_searches
show Show a saved search
update Update a saved search

Examples:

.. code:: bash

p y p e r t r a i l s a v e d_{s} e a r c h e s c r e a t e - - p a y l o a d^{'} {" s e a r c h [n a m e] " : " f o o ", " s e a r c h [q u e r y] " : " b a r "}^{'}

pypertrail saved_searches delete 1

p y p e r t r a i l s a v e d_{s} e a r c h e s l i s t

pypertrail saved_searches show 1

p y p e r t r a i l s a v e d_{s} e a r c h e s u p d a t e 1 - - p a y l o a d^{'} {" s e a r c h [q u e r y] " : " a n o t h e r_{q} u e r y "}^{'} G r o u p s . . c o d e :: p l a i n U s a g e : p a p e r t r a i l . p y g r o u p s [O P T I O N S] C O M M A N D [A R G S] . . . O p t i o n s : - h, - - h e l p S h o w t h i s m e s s a g e a n d e x i t . C o m m a n d s : d e l e t e D e l e t e a g r o u p l i s t L i s t g r o u p s s h o w S h o w a g r o u p u p d a t e U p d a t e a g r o u p E x a m p l e s : . . c o d e :: b a s h

pypertrail groups delete 1

p y p e r t r a i l g r o u p s l i s t

pypertrail groups show 1

p y p e r t r a i l g r o u p s u p d a t e 1 - - p a y l o a d^{'} {" g r o u p [n a m e] " : " a n o t h e r_{n} a m e "}^{'} S e a r c h . . c o d e :: p l a i n U s a g e : p a p e r t r a i l . p y s e a r c h e v e n t s [O P T I O N S] S e a r c h e v e n t s O p t i o n s : - q, - - q u e r y T E X T T e r m s t o q u e r y . - s, - - s y s t e m I N T E G E R S y s t e m t o s e a r c h . - g, - - g r o u p I N T E G E R G r o u p t o s e a r c h . - e, - - m i n - t i m e I N T E G E R E a r l i e s t t i m e t o s e a r c h f r o m . - l, - - m a x - t i m e I N T E G E R L a t e s t t i m e t o s e a r c h f r o m . - f, - - f o l l o w C o n t i n u e r u n n i n g a n d p r i n t i n g n e w e v e n t s (o f f) . - d, - - d e l a y I N T E G E R D e l a y b e t w e e n r e f r e s h (5) . - j, - - j s o n O u t p u t r a w J S O N d a t a (o f f) . - c, - - c o l o r [p r o g r a m | s y s t e m | a l l | o f f] A t t r i b u t e (s) t o c o l o r i z e b a s e d o n (p r o g r a m) . - h, - - h e l p S h o w t h i s m e s s a g e a n d e x i t . E x a m p l e s : . . c o d e :: b a s h

pypertrail search events

p y p e r t r a i l s e a r c h e v e n t s - - f o l l o w

pypertrail search events --follow --color program

p y p e r t r a i l s e a r c h e v e n t s - - f o l l o w - - q u e r y s s h d

pypertrail search events --follow --json

Systems
~~~~~~~

.. code:: plain

Usage: papertrail.py systems [OPTIONS] COMMAND [ARGS]...

Options:
-h, --help Show this message and exit.

Commands:
create Create a saved search
delete Delete a system
join_group Join a group
leave_group Leave a group
list List systems
show Show a system
update Update a system

Examples:

.. code:: bash

p y p e r t r a i l s y s t e m s c r e a t e - - p a y l o a d^{'} {" s y s t e m [n a m e] " : " f o o ", " s y s t e m [h o s t n a m e] " : " b a r ", " d e s t i n a t i o n_{p} o r t " : 46865}^{'}

pypertrail systems delete 1

p y p e r t r a i l s y s t e m s j o i n_{g} r o u p 1 - - p a y l o a d^{'} {" g r o u p_{i} d " : 10}^{'}

pypertrail systems leave_group 1 --payload '{"group_id":10}'

p y p e r t r a i l s y s t e m s l i s t

pypertrail systems show 1

p y p e r t r a i l s y s t e m s u p d a t e 1 - - p a y l o a d^{'} {" s y s t e m [n a m e] " : " a n o t h e r_{n} a m e "}^{'} U s e r s . . c o d e :: p l a i n U s a g e : p a p e r t r a i l . p y u s e r s [O P T I O N S] C O M M A N D [A R G S] . . . O p t i o n s : - h, - - h e l p S h o w t h i s m e s s a g e a n d e x i t . C o m m a n d s : d e l e t e D e l e t e a u s e r i n v i t e I n v i t e a u s e r l i s t L i s t u s e r s E x a m p l e s : . . c o d e :: b a s h

pypertrail users delete 1

p y p e r t r a i l u s e r s i n v i t e - - p a y l o a d^{'} {" e m a i l " : " c o n t a c t @ q u e n t . i n ", " r e a d_{o} n l y " : t r u e}^{'}

pypertrail users list

Documentation
=============

- https://pypertrail.readthedocs.io
- http://help.papertrailapp.com/kb/how-it-works/http-api

History
=======

View the `changelog`_

Authors
=======

- `Quentin Rousseau`_

License
=======

.. code:: plain

Copyright (c) 2016 Quentin Rousseau <contact@quent.in>

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.

.. _changelog: https://github.com/kwent/pypertrail/blob/master/HISTORY.rst
.. _Quentin Rousseau: https://github.com/kwent

.. |pypi| image:: https://img.shields.io/pypi/v/pypertrail.svg
:target: https://pypi.python.org/pypi/pypertrail
.. |travis| image:: https://img.shields.io/travis/kwent/pypertrail.svg
:target: https://travis-ci.org/kwent/pypertrail
.. |doc| image:: https://readthedocs.org/projects/pypertrail/badge/?version=latest
:target: https://pypertrail.readthedocs.io/en/latest/?badge=latest
.. |pyup| image:: https://pyup.io/repos/github/kwent/pypertrail/shield.svg
:target: https://pyup.io/repos/github/kwent/pypertrail/

=======
History
=======

1.0.0 (2016-10-06)
------------------

* First release on PyPI.

Algorithm	Hash digest
SHA256	`3f98883f179b1b4f74d07b0aae714689d3b9829295dc4d84d18847517c62b9f1`
MD5	`351baa6830ab41b3430ab8fea60c72c3`
BLAKE2b-256	`d4a4baba9e426875c20b49b29901092afab4d2f7fd2bd973893cb03918a7f50e`

Algorithm	Hash digest
SHA256	`e7ea36b2d6a54aa8b2fa37fe67fac79b478e1eb317f2177774701dbaf5bc302e`
MD5	`56e5155d28227d27bb52d01dc298ee1e`
BLAKE2b-256	`07a20df56f8982a34147df07548da8080372109d2f626d0dc55e0c9b5569ae7b`

pypertrail 1.0.0

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes