{ "info": { "author": "leecampbellc85", "author_email": "lee.campbell.c85@hotmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Build Tools" ], "description": "Empty example PYPI package by leecampbellc85\r\n############################################\r\n\r\n\r\nChange log \r\n###########\r\n\r\n* version 0.0.1.12\r\n * Basic unittest for Core module\r\n * Documentation\r\n* version 0.0.1.6\r\n * Execute this from command-line (pfpy -v)\r\n* version 0.0.0.1\r\n * Init files and directory structure\r\n\r\n\r\nRequirements\r\n#############\r\n\r\n* Linux OS or Windows OS\r\n* Python (2.7)\r\n\r\n\r\nBasic install\r\n#############\r\n\r\n.. code-block::\r\n\r\n pip install perfect-pypi --upgrade\r\n\r\n\r\n(install without cache: pip install perfect-pypi --no-cache-dir )\r\n\r\n\r\nYou can find the detailed documentation in https://github.com/leecampbellc85/perfect-pypi.\r\n\r\n\r\nUsage\r\n######\r\n\r\nFrom command line\r\n**********************\r\n\r\n* Usage:\r\n * pfpy --version\r\n * pfpy core --input TEXT\r\n * pfpy core -i TEXT -o string\r\n * pfpy core -i TEXT --output json\r\n* Arguments:\r\n* Options:\r\n * **-h** **--help** show this help message and exit\r\n * **-v --version** show version and exit\r\n * **--verbose** print status messages\r\n * **-i --input** set input and exit\r\n * **-o --output** output format default is string. Possible values: string, json\r\n\r\nYou merely type the **pfpy** command to commandline with the required parameters.\r\n* *pfpy --version* or *pfpy -v* : Get version of our package\r\n* *pfpy core --input TEXT * or *pfpy core -i TEXT -o string* : Write out to screen the TEXT in string format. (module: core)\r\n* ``` pfpy core -i TEXT --output json ``` : Write out to screen the TEXT in json format. (module: core)\r\n\r\nFrom Python\r\n*************************\r\n\r\nImport the required module from perfectpypi package in python\r\n\r\n.. code-block::\r\n\r\n import perfectpypi\r\n\r\n\r\nExamples\r\n########\r\n\r\nFrom command line\r\n**************************\r\n\r\n1. Get version:\r\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\r\n\r\n.. code-block::\r\n\r\n pfpy -v\r\n\r\n\r\nResult: \r\n.. code-block::\r\n\r\n 0.0.1.11\r\n\r\n\r\n\r\n2. Write out text in string format:\r\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\r\n\r\n.. code-block::\r\n\r\n pfpy core -i \"Hello World\"\r\n\r\nResult: \r\n\r\n.. code-block::\r\n\r\n Hello World\r\n\r\n\r\n\r\n3. Write out text in json format:\r\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\r\n\r\n.. code-block::\r\n\r\n pfpy core -i \"Hello World\" -o json\r\n\r\n\r\nResult: \r\n\r\n.. code-block::\r\n\r\n [{'text': 'Hello World'}]\r\n\r\n\r\n\r\nFrom Python\r\n*********************\r\n\r\nEvery example assumes you are in python shell\r\n\r\n1. Execute core module related unittest\r\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\r\n\r\n.. code-block::\r\n\r\n from perfectpypi.core.perfectpypi_core_unittest import *\r\n testResult = runUnittests()\r\n\r\n\r\nResult:\r\n\r\n.. code-block::\r\n\r\n test_input (perfectpypi.core.perfectpypi_core_unittest.TestCoreModule) ... All tests passed so far!\r\n ok\r\n test_output (perfectpypi.core.perfectpypi_core_unittest.TestCoreModule) ... All tests passed so far!\r\n ok\r\n\r\n ----------------------------------------------------------------------\r\n Ran 2 tests in 0.003s\r\n\r\n OK\r\n\r\n\r\n2. Write out text in string format:\r\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\r\n\r\n.. code-block::\r\n\r\n from perfectpypi.core.perfectpypi_core import *\r\n getText(\"Hello World\")\r\n\r\n\r\nResult: \r\n\r\n.. code-block::\r\n\r\n Hello World\r\n\r\n\r\n\r\n3. Write out text in json format:\r\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\r\n\r\n.. code-block::\r\n\r\n from perfectpypi.core.perfectpypi_core import *\r\n getText(\"Hello World\", \"json\")\r\n\r\nResult: \r\n\r\n.. code-block::\r\n\r\n {'text': 'Hello World'}\r\n\r\n\r\n\r\nKnown issues\r\n#############\r\n\r\n\r\n**Permission denied on /usr/bin/pfpy**\r\n*******************************************\r\n\r\nSometimes you are facing the following issue when you execute the **pfpy** command:\r\n\r\n.. code-block::\r\n\r\n -bash: /usr/bin/pfpy: Permission denied\r\n\r\n\r\nSolution to execute the following command:\r\n\r\n.. code-block::\r\n\r\n sudo chmod +x /usr/bin/pfpy\r\n\r\n\r\n**Command not found on /usr/bin/pfpy**\r\n*******************************************\r\nAlthough the package is well prepared sometimes you are facing the following issue after a package update when you execute the **pfpy** command:\r\n\r\n.. code-block::\r\n\r\n /usr/bin/pfpy: line 2: $'\\r': command not found\r\n /usr/bin/pfpy: line 19: syntax error: unexpected end of file\r\n\r\n\r\nSolution to execute the following command:\r\n\r\n.. code-block::\r\n\r\n sudo dos2unix /usr/bin/pfpy\r\n\r\n\r\n\r\nLICENSE (MIT)\r\n#############\r\n\r\n\r\nCopyright (c) 2019\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of\r\nthis software and associated documentation files (the \"Software\"), to deal in\r\nthe Software without restriction, including without limitation the rights to\r\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\r\nof the Software, and to permit persons to whom the Software is furnished to do\r\nso, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all\r\ncopies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\nSOFTWARE.\r\n\r\n\r\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/leecampbellc85/perfect-pypi", "keywords": "python leecampbellc85hu", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "perfect-pypi", "package_url": "https://pypi.org/project/perfect-pypi/", "platform": "", "project_url": "https://pypi.org/project/perfect-pypi/", "project_urls": { "Homepage": "https://github.com/leecampbellc85/perfect-pypi" }, "release_url": "https://pypi.org/project/perfect-pypi/0.0.1.12/", "requires_dist": [ "docopt" ], "requires_python": ">=2.6, <3", "summary": "perfect-pypi - Empty example PYPI package by leecampbellc85", "version": "0.0.1.12" }, "last_serial": 5410450, "releases": { "0.0.1.12": [ { "comment_text": "", "digests": { "md5": "669dea67476686835c23810292ca8539", "sha256": "f8d4509fc08e656ec3514f2ce7a945f08d88f7a0de55f08842fc8dff6453a8e1" }, "downloads": -1, "filename": "perfect_pypi-0.0.1.12-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "669dea67476686835c23810292ca8539", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.6, <3", "size": 7026, "upload_time": "2019-06-17T14:33:48", "url": "https://files.pythonhosted.org/packages/47/55/17e8a66e8ff989ae12c728bba8fb519de11c97786a5aa077c74a41fc1c3e/perfect_pypi-0.0.1.12-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ac6fb263a021c36f12e7494f9afb8502", "sha256": "920f84bde5d4f963d5c5a13a2d738238882a1921aa93f82c69d4ec6860d4eeed" }, "downloads": -1, "filename": "perfect-pypi-0.0.1.12.tar.gz", "has_sig": false, "md5_digest": "ac6fb263a021c36f12e7494f9afb8502", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.6, <3", "size": 6107, "upload_time": "2019-06-17T14:33:50", "url": "https://files.pythonhosted.org/packages/b3/1a/b882509319a6551a3a3c08c4cbcbe555382c471740aba7a707b3491d6e69/perfect-pypi-0.0.1.12.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "669dea67476686835c23810292ca8539", "sha256": "f8d4509fc08e656ec3514f2ce7a945f08d88f7a0de55f08842fc8dff6453a8e1" }, "downloads": -1, "filename": "perfect_pypi-0.0.1.12-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "669dea67476686835c23810292ca8539", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.6, <3", "size": 7026, "upload_time": "2019-06-17T14:33:48", "url": "https://files.pythonhosted.org/packages/47/55/17e8a66e8ff989ae12c728bba8fb519de11c97786a5aa077c74a41fc1c3e/perfect_pypi-0.0.1.12-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ac6fb263a021c36f12e7494f9afb8502", "sha256": "920f84bde5d4f963d5c5a13a2d738238882a1921aa93f82c69d4ec6860d4eeed" }, "downloads": -1, "filename": "perfect-pypi-0.0.1.12.tar.gz", "has_sig": false, "md5_digest": "ac6fb263a021c36f12e7494f9afb8502", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.6, <3", "size": 6107, "upload_time": "2019-06-17T14:33:50", "url": "https://files.pythonhosted.org/packages/b3/1a/b882509319a6551a3a3c08c4cbcbe555382c471740aba7a707b3491d6e69/perfect-pypi-0.0.1.12.tar.gz" } ] }