libmaker 0.1

A library that makes making libraries and uploading them to pypi easy

Have you been searching for hours trying to figure out how to make and update pip libraries? Well, search no more! LibMaker makes it easy to upload your code to pip. Note that you will need a pip account.

Installation

As easy as pip install LibraryMaker or you could download it with the button on the right unzip it, go inside the directory, and run python setup.py install

Usage

import the library, libmaker, and then use the create and update functions as shown below

Create: create(name,path_to_code,description,version,username,password,readme=’’,keywords=[])

The create function, as the name implies, creates a library. Basic example usage is shown below.

import libmaker

libmaker.create('mylibrary','/path/to/my/code','This is a random test library','0.1','myusername','mypassword')

You can also add extra parameters like a readme file (long description) and a special list of keywords so your library can be found. Example usage of these is below:

import libmaker

readmestring="""this is a multiline string made of restructured text"""

libmaker.create('mylibrary','/path/to/my/code','This is a random test library','0.1','myusername','mypassword',readme=readmestring,keywords=['random','library'])

Here is a list of the required parameters and what they do:

name - The name of your library. Will not work if you use a name that already exists.

path_to_code - The absolute path to your code. This is the code that will be in your library

description - A short description of your library

version - The first version of your library (a string)

username - Your pip account username

password - Your pip account password

Here is a list of the flags (non-required parameters) and what they do:

readme - A multiline string of ReStructuredText that will be displayed on your pip homepage

keywords - A list of keywords that will be used to help find your library when people search for it

Update: update(name,path_to_code,version,username,password,readme=’what it was before’,keywords=[‘what it was before’],description=’what it was before’)

The update function updates a library. Make sure you are in the same directory as when you created the library. Basic usage is shown below.

import libmaker

libmaker.update('mylibrary','/path/to/code','0.2','myusername','mypassword')

This will update pypi with your new code. You can also make other changes as shown below.

import libmaker

libmaker.update('mylibrary','/path/to/code','0.3','myusername','mypassword',readme='new restructured text',keywords=['random','library','updated'],description='the new and improved mylibrary')

Here is a list of the required parameters:

name - The name of your library, you may not change it or it won’t work

path_to_code - The path to your python code

version - Your new version (if it was 0.1, you need to change it to 0.2 for it to work)

username - Your pip account username

password - Your pip account password

Here is a list of the non-required parameters

readme - A multiline string of ReStructuredText that will be displayed on your pip homepage. You may make changes from the previous updates

keywords - A list of keywords that will be used to help find your library when people search for it. You may make changes from the previous updates

description - A short description of your library. You may change this from the previous updates