Skip to main content

Package for demonstration purposes in documentation

Project description

PyPI version License Documentation

This project exists so I can play around with integrating CI/CD (and figure out what that actually means) into my projects, and publish documentation to Read the Docs automatically.

I basically just want to give myself a skeleton to work from where I do things “the right way”, so I can use that as a base for any real projects I may want to do in the future.

Huge shout-out to Chris Billington for his amazing inotify-simple package, which was part of what inspired me to do something like this in the first place. It’s a simple, extremely useful package with great documentation. Top notch.

View on PyPI | Fork me on gitgud | Read the docs

Installation

Installation of the fish-pen package should be as simple as running the command:

python3 -m pip install fish_pen

and you should be up and running.

I’ll get around to distributing an apt package eventually probably. This will allow you to install the package from your local installation as well. This is excellent for if you for instance have packages which you don’t want to publish on PyPI, but still want to install into a virual environment somewhere. If this is the case, installation will be as simple as

python3 -m pip install --find-links=/usr/share/wheels fish_pen

And it should work the exact same way.

Example usage

You can do some really cool stuff with this example package! Watch:

import fish_pen

fish_pen.hello()

Which will print Hello world! for you! Isn’t that neat?

Markdown is a little limited, so more documentation is of course available at Read the docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fish_pen-0.0.4.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

fish_pen-0.0.4-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file fish_pen-0.0.4.tar.gz.

File metadata

  • Download URL: fish_pen-0.0.4.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.0

File hashes

Hashes for fish_pen-0.0.4.tar.gz
Algorithm Hash digest
SHA256 1fdb378ccbd08749542da64b9cf8c14fd56f85faed8f64943a10a043619542c6
MD5 aa972e15aa3e86c10c78367531836c22
BLAKE2b-256 6b423b047d516d235c11fac853d8ad1646692d0d6a031aae6f792bff38005a28

See more details on using hashes here.

File details

Details for the file fish_pen-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: fish_pen-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.0

File hashes

Hashes for fish_pen-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 436d8701211ce75732e9e49955e2030adef8d913aa5bc3bcd47136fe3d182c81
MD5 4943abedca7499068c884b961c070709
BLAKE2b-256 c75c312cf6f6a0ae91ba7b8d58c2e8b1c09b592f54c9a85fe0d5e9f514edf618

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page