{ "info": { "author": "Raul Gonzalez", "author_email": "mindbender@gmail.com", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python :: 3.5" ], "description": "===========\r\nHola Mundo\r\n===========\r\n\r\nProject Purpose\r\n================\r\nThis project demonstrates how to get an open source python project actually \r\nopen sourced. This means getting:\r\n\r\n - Getting the source control.\r\n - Getting a dev environment.\r\n - Getting test and coverage.\r\n - Getting the documentation.\r\n - Publishing to Pypi.\r\n - Publishing the docs.\r\n \r\nIf you care to jump straight to the dry explanations of how *Hola Mundo* \r\nconfiguration can help as examples for getting an open source Pypi project, then\r\ngenerate the help documentation, and it will guide you across the various \r\nways that *Hola Mundo* comes together to be open source worthy.\r\n\r\nWhat follows is *Hola Mundo* the App!\r\n\r\nshare and enjoy\r\n\r\n\r\n=================\r\nHola Mundo 0.0.3\r\n=================\r\n\r\nHola Munda Usage\r\n=================\r\n\r\n*Hola Mundo* makes it easy for you to internationalize your greetings.\r\n\r\nThe execution of *Hola Mundo* can be accomplished with:\r\n\r\n > python -m hola_mundo.main \r\n\r\n or\r\n \r\n > python hola_mundo/main.py \r\n \r\n :index: An optional integer that will display `Hola Mundo` in a given\r\n language. If not provided, then a random version of `Hola Mundo` will\r\n be provided.\r\n\r\n\r\nDocumentation\r\n--------------\r\n\r\nFor the latest documentation, visit http://neoinsanity.github.io/hola_mundo/\r\n\r\n====================\r\nProject Development\r\n====================\r\n\r\nIf you are interested in developing **Hola Mundo** code, utilize the helper \r\nscripts in the *hola_mundo/bin* directory. Just follow the instruction below \r\nfor setting up the \r\n\r\nGet the Source First!\r\n----------------------\r\n\r\nThe latest stable release source of **Hola Mundo** can be found on the\r\nat https://github.com/neoinsanity/hola_mundo. \r\n\r\nRun the Dev Environment Setup\r\n------------------------------\r\n\r\nPrior to running the dev setup scripts:\r\n\r\n 1. Ensure that *python3* is installed. You can check by using the command:\r\n \r\n python3 --version\r\n \r\n 2. Ensure that you have *virtualenv* installed. You can check by using the\r\n command:\r\n \r\n virtualenv --version\r\n \r\nKeep in mind that all scripts to be executed are assumed to be from the \r\nproject `root` directory. This is the directory with the *setup.py* file.\r\n\r\nOnce you have the pre-requisites out of the way, we can run the development \r\nconfiguration scripts.\r\n\r\n\r\nPrep the development environment with the command:\r\n\r\n > bin/dev_setup.sh\r\n\r\nThis command will setup the virtualenv for the project in the directory \r\n*/venv*. It will also install the **Hola Mundo** in a develop mode, with the\r\ncreation of a development egg file.\r\n\r\nThe Development Environment Usage\r\n==================================\r\n\r\nIn this section will be demonstrated the dev tools available for a session of\r\nsource development. This features enabling the dev environment, executing the\r\nunit test with coverage, and building the docs.\r\n\r\nEnable the Development Environment\r\n-----------------------------------\r\n\r\nThis command MUST be executed at the beginning of each developer session. It \r\nwill ensure that the dev tools are available, and that the virtual \r\nenvironment is active.\r\n\r\nThe command is given below, note that it is sourced to set virtualenv:\r\n\r\n > . bin/enable_dev.sh\r\n \r\nor\r\n\r\n > source bin/enable_dev.sh\r\n \r\nEnabling the dev environment adds the *bin* directory scripts to environment \r\n*PATH*. This allows for the commands below to be typed at the prompt from the\r\nproject . \r\n\r\nRunning Tests and Code Coverage\r\n--------------------------------\r\n\r\nTo run the unit tests:\r\n\r\n > run_tests.sh\r\n\r\nTo view the code coverage report, open the file \r\n`root`/BUILD/CONVERAGE_REPORT/index.html.\r\n\r\nBuilding Documentation\r\n-----------------------\r\n\r\nTo run the documentation generation:\r\n\r\n > doc_build.sh\r\n\r\nTo view the documentation, open the file `root`/BUILD/doc/index.html.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https//github.com/neoinsanity/hola_mundo", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "hola_mundo", "package_url": "https://pypi.org/project/hola_mundo/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/hola_mundo/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https//github.com/neoinsanity/hola_mundo" }, "release_url": "https://pypi.org/project/hola_mundo/0.0.3/", "requires_dist": null, "requires_python": null, "summary": "Hola Mundo!", "version": "0.0.3" }, "last_serial": 2003690, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "fbd73ecd4804420a8f1e17c2784175ab", "sha256": "bbd8bd64c7527c7fa59ad5138ef26b61d4b29f70db8a13ef8dff421c62d27800" }, "downloads": -1, "filename": "hola_mundo-0.0.2.tar.gz", "has_sig": false, "md5_digest": "fbd73ecd4804420a8f1e17c2784175ab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4581, "upload_time": "2016-03-12T23:29:23", "url": "https://files.pythonhosted.org/packages/c6/c4/7fcbc523b86c3381ff127ef9be713d01297235917f3ed0b4308ff68dffdb/hola_mundo-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "a5400e063ad5eee9bc846689f8853f66", "sha256": "ceeb1e6eec2d47894b6dc9565fb9c0e1eb0554ea0263882771a73f65e89dfa17" }, "downloads": -1, "filename": "hola_mundo-0.0.3.tar.gz", "has_sig": false, "md5_digest": "a5400e063ad5eee9bc846689f8853f66", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8508, "upload_time": "2016-03-12T23:35:51", "url": "https://files.pythonhosted.org/packages/51/91/597570963797d8a5fe47515010f30242deaea798e5aaaddb5361e8492c72/hola_mundo-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a5400e063ad5eee9bc846689f8853f66", "sha256": "ceeb1e6eec2d47894b6dc9565fb9c0e1eb0554ea0263882771a73f65e89dfa17" }, "downloads": -1, "filename": "hola_mundo-0.0.3.tar.gz", "has_sig": false, "md5_digest": "a5400e063ad5eee9bc846689f8853f66", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8508, "upload_time": "2016-03-12T23:35:51", "url": "https://files.pythonhosted.org/packages/51/91/597570963797d8a5fe47515010f30242deaea798e5aaaddb5361e8492c72/hola_mundo-0.0.3.tar.gz" } ] }