pyshields¶
This is the documentation of pyshields.
Note
This is the main page of your project’s Sphinx documentation.
It is formatted in reStructuredText. Add additional pages
by creating rst-files in docs and adding them to the toctree below.
Use then references in order to link them from this page, e.g.
Contributors and Changelog.
It is also possible to refer to the documentation of other Python packages
with the Python domain syntax. By default you can reference the
documentation of Sphinx, Python, NumPy, SciPy, matplotlib,
Pandas, Scikit-Learn. You can add more by extending the
intersphinx_mapping in your Sphinx’s conf.py.
The pretty useful extension autodoc is activated by default and lets you include documentation from docstrings. Docstrings can be written in Google style (recommended!), NumPy style and classical style.
Contents¶
pyshields¶
pyshields is a project inspired by https://shields.io/ and badger.
Note¶
This project has been set up using PyScaffold 3.2.2. For details and usage information on PyScaffold see https://pyscaffold.org/.
License¶
The MIT License (MIT)
Copyright (c) 2019 ShixiangWang
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.
Contributors¶
- ShixiangWang <wangshx@shanghaitech.edu.cn>
pyshields¶
pyshields package¶
Submodules¶
pyshields.skeleton module¶
This is a skeleton file that can serve as a starting point for a Python console script. To run this script uncomment the following lines in the [options.entry_points] section in setup.cfg:
- console_scripts =
- fibonacci = pyshields.skeleton:run
Then run python setup.py install which will install the command fibonacci inside your current environment. Besides console scripts, the header (i.e. until _logger…) of this file can also be used as template for Python modules.
Note: This skeleton file can be safely removed if not needed!
-
pyshields.skeleton.fib(n)[source]¶ Fibonacci example function
Parameters: n (int) – integer Returns: n-th Fibonacci number Return type: int
-
pyshields.skeleton.main(args)[source]¶ Main entry point allowing external calls
Parameters: args ([str]) – command line parameter list
-
pyshields.skeleton.parse_args(args)[source]¶ Parse command line parameters
Parameters: args ([str]) – command line parameters as list of strings Returns: command line parameters namespace Return type: argparse.Namespace