semvec/pypi-packages huggingface dataset:
scrible 2.0.2
Note taking application
License: MIT
Keywords: notes taking app scrible scribbler scribble

``Scrible`` Python *Console application* for taking notes
======================================================================

    New in version 0.3:

    - Beautiful ui with added commands such as ``sync`` for automatic 
      synchronization of notes

    New in version 0.2:

    - Better listing and searching options with ``--limit`` to get
      specific number of items


**Scrible** enables you create short and descriptive notes with cloud backup
*easily*:

.. code:: python

    """Scrible.

    Usage:
	    createnote  (<note_title>) [-m]
	    viewnote    (<note_id>) [-m]
	    deletenote  (<note_id> | -a)
	    searchnotes (<query_string>) [(--limit <items>)]
	    viewnote    (<note_id>)
	    listnotes   [(--limit <items>)]
	    next
	    export      (<filename>)
	    import      (<filename>)
	    sync 
	    scrible (-s | --start)
	    scrible (-h | --help | --version)
	Options:
	    -s, --start  Interactive Mode
	    -h, --help  Show this screen and exit.
	    -m          Starts creating note body

    """

As you can see, the commands to use are few and easy to remember.

Installation
======================================================================

Use `pip <http://pip-installer.org>`_ or easy_install::

    pip install scrible

Testing
======================================================================

You can run unit tests preferably by installing nosetest and run from root of the folder:

    nosetests

Usage pattern format
----------------------------------------------------------------------

**Usage pattern** depends on the command you want to execute

- View specific notes 
.. code:: python

	viewnote (<note_id>) [-m]

- Create note with just title 
.. code:: python 

	createnote  (<note_title>)

- Create note with title and body
.. code:: python 

	createnote  (<note_title>) [-m]

- Delete notes
.. code:: python 

	deletenote  (<note_id> | -a)

- Search notes
.. code:: python 

	searchnotes (<query_string>) [(--limit <items>)]

- List notes
.. code:: python 

	listnotes [(--limit <items>)]

- Import notes
.. code:: python 

	import (<filename>)

- Export notes
.. code:: python 

	export (<filename>)

- Manually sync notes

	sync 


Launching program
======================================================================

    scrible --start
testing.elasticsearch 0.3.0
Automatically sets up an elasticsearch instance in a temporary directory, and destroys it after testing
License: MIT
Keywords: testing,elasticsearch

testing.elasticsearch
=====================

`testing.elasticsearch` automatically sets up an elasticsearch instance in a
temporary directory, and destroys it after testing. It's useful as a pytest
fixture for testing interactions with elasticsearch in an isolated manner.


Implementation is based off the awesome  `testing.redis <https://bitbucket.org/tk0miya/testing.redis>`_ module.

Example usage:

.. code-block:: python

    import testing.elasticsearch
    import pyes.es import ES

    # launch new elasticsearch server:
    with testing.elasticsearch.ElasticSearchServer() es:
        elasticsearch = ES(es.uri())
        # perform any testing with elasticsearch here

    # elasticsearch server is terminated and cleaned up here


You can change the server configuration by specifying a `config` dict:

.. code-block:: python

    with ElasticSearchServer(config={
        'logger.level': 'DEBUG',
        # Keep index in memory
        'index.store.type': 'mmapfs',
    }) as es:
        ...


...or by setting them on the `config` attribute before starting the server:

.. code-block:: python

    es = ElasticSearchServer()
    es.config['logger.level'] = 'DEBUG'
    es.start()


You can also setup a pytest fixture:

.. code-block:: python

    @pytest.fixture(scope='session')
    def elasticsearch(request):
        """
        A testing fixture that provides a running elasticsearch server.
        """
        es = ElasticSearchServer()
        es.start()
        request.addfinalizer(es.stop)
        return es


Testing
-------

To run tests you'll need to install the test requirements::

    pip install -r src/tests/requirements.txt

Run tests::

    python src/tests/runtests.py