Getting Started¶
This document will show you a quick introduction on how to easily install and use the infocards library.
Requirements¶
- fuzzywuzzy >= 0.2.1
- pg8000 >= 1.9.13
- PyMYSQL >= 0.6.2
- SQLAlchemy >= 0.9.7
Installation¶
infocards has been tested on Python 2.7 and 3.4, although it should work in other versions such as 2.5. The library can be installed from source by downloading and extracting the compressed file and then running:
$ python setup.py install
setuptools will also try to download the additional libraries required in the code.
However, the recommended installation method is to directly use pip to download and install the package (including dependencies) from the package index:
$ pip install infocards
Creating an archive¶
Once installed, creating a new archive (or connecting to an already existing one) is as easy as this:
from infocards import Archive
ar = Archive(CONNECTION_INFORMATION) # Be creative with your archive name!
ar.create_archive() # Use this only if you are creating an archive from scratch
Done, your archive is ready and awaiting its cards. From version 0.2.0 and up, the library supports working with MySQL, PostgreSQL and SQLite databases. For details on the connection information for each database type, check Archive.
Inserting a new card¶
Cards contain very little information, so creating a new card is very easy:
from infocards import Archive
ar = Archive('myarchive.dat')
title = 'This is my new card'
description = 'What a nice little description'
content = 'You can be as creative as you want when writing your content!!'
tags = 'tags are simply words separated by a whitespace'
are.new_card(title, description, content, tags)
You must take into account, however, that there cannot be two cards with the same title in the archive.
Retrieving a card¶
Cards have a unique title. In order to get the information on a specific card, simply ask the archive for that title:
from infocards import Archive
ar = Archive('myarchive.dat')
my_card = ar.get_card('This is my new card') # If a card with that title exists, now you can access all its information
Retrieving a list of all the cards¶
If you want a complete list of all the Cards in the archive, simply do:
from infocards import Archive
ar = Archive('myarchive.dat')
all_cards = ar.all()
Updating a card¶
Cards can also be modified/updated easily so that you can add that information you forgot when creating the card!:
from infocards import Archive
ar = Archive('myarchive.dat')
my_card = ar.get_card('This is my new card') # Need to modify the original card
my_card.title = 'I like this title better' # You can even change the title!
my_card.content = 'Cards are easy to use'
ar.update_card('This is my new card', my_card) # Card updated!
As renaming a card is possible, modifications require the old title as well as the new card information.
Removing a card¶
Of course, you can even remove Cards from your archive. Simply use the card title, exactly the same as when retrieving a card:
from infocards import Archive
ar = Archive('myarchive.dat')
ar.remove_card('This is my new card') # Gone!
Searching for cards¶
Having to know all the card titles by heart can (and will) become frustrating. For that reason, the library includes a simple search functionality:
from infocards import Archive
ar = Archive('myarchive.dat')
# Search for cards containing 'Python'
result = ar.search('Python') # List of cards