pypi-project 0.0.1.11

pypi-project - Empty example PYPI package by The1bit

Empty example PYPI package by The1bit

Change log

• version 0.0.1.11

  • Basic unittest for Core module

  • Documentation

• version 0.0.1.6

  • Execute this from command-line (pypr -v)

• version 0.0.0.1

  • Init files and directory structure

Requirements

• Linux OS or Windows OS

• Python (2.7)

Basic install

pip install pypi-project --upgrade

(install without cache: pip install pypi-project –no-cache-dir )

You can find the detailed documentation in https://github.com/the1bit/pypi-project.

Usage

From command line

• Usage:

  • pypr –version

  • pypr core –input TEXT

  • pypr core -i TEXT -o string

  • pypr core -i TEXT –output json

• Arguments:

• Options:

  • -h –help show this help message and exit

  • -v –version show version and exit

  • –verbose print status messages

  • -i –input set input and exit

  • -o –output output format default is string. Possible values: string, json

You merely type the pypr command to commandline with the required parameters. * pypr –version or pypr -v : Get version of our package * pypr core –input TEXT * or *pypr core -i TEXT -o string : Write out to screen the TEXT in string format. (module: core) * ` pypr core -i TEXT --output json ` : Write out to screen the TEXT in json format. (module: core)

From Python

Import the required module from pypiproject package in python

import pypiproject

Examples

From command line

1. Get version:

pypr -v

Result: .. code-block:

0.0.1.11

2. Write out text in string format:

pypr core -i "Hello World"

Result:

Hello World

3. Write out text in json format:

pypr core -i "Hello World" -o json

Result:

[{'text': 'Hello World'}]

From Python

Every example assumes you are in python shell

1. Execute core module related unittest

from pypiproject.core.pypiproject_core_unittest import *
testResult = runUnittests()

Result:

test_input (pypiproject.core.pypiproject_core_unittest.TestCoreModule) ... All tests passed so far!
ok
test_output (pypiproject.core.pypiproject_core_unittest.TestCoreModule) ... All tests passed so far!
ok

----------------------------------------------------------------------
Ran 2 tests in 0.003s

OK

2. Write out text in string format:

from pypiproject.core.pypiproject_core import *
getText("Hello World")

Result:

Hello World

3. Write out text in json format:

from pypiproject.core.pypiproject_core import *
getText("Hello World", "json")

Result:

{'text': 'Hello World'}

Known issues

Permission denied on /usr/bin/pypr

Sometimes you are facing the following issue when you execute the pypr command:

-bash: /usr/bin/pypr: Permission denied

Solution to execute the following command:

sudo chmod +x /usr/bin/pypr

Command not found on /usr/bin/pypr

Although the package is well prepared sometimes you are facing the following issue after a package update when you execute the pypr command:

/usr/bin/pypr: line 2: $'\r': command not found
/usr/bin/pypr: line 19: syntax error: unexpected end of file

Solution to execute the following command:

sudo dos2unix /usr/bin/pypr

LICENSE (MIT)

Copyright (c) 2019

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.