Browse Source

- Preparing for new release.

- Readme is now in markdown.
master
Franco Masotti 2 months ago
parent
commit
1418d84983
Signed by: frnmst
GPG Key ID: 24116ED85666780A
  1. 2
      .gitignore
  2. 17
      .pre-commit-config.yaml
  3. 3
      CONTRIBUTING.md
  4. 4
      MANIFEST.in
  5. 2
      Makefile
  6. 60
      README.md
  7. 85
      README.rst
  8. 6
      docs/conf.py
  9. 2
      docs/contributing.rst
  10. 2
      docs/copyright_license.rst
  11. 2
      docs/workflow.rst
  12. 2
      packages/aur/PKGBUILD
  13. 9
      setup.py

2
.gitignore vendored

@ -1,6 +1,4 @@
Pipfile.lock
*.md
*.MD
# Byte-compiled / optimized / DLL files
__pycache__/

17
.pre-commit-config.yaml

@ -2,7 +2,7 @@
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.0.1
rev: v4.2.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
@ -15,7 +15,7 @@ repos:
- id: debug-statements
- repo: https://github.com/pre-commit/mirrors-yapf
rev: 'v0.31.0' # Use the sha / tag you want to point at
rev: 'v0.32.0' # Use the sha / tag you want to point at
hooks:
- id: yapf
args: ['--style', '{based_on_style: pep8; indent_width: 4}']
@ -28,7 +28,7 @@ repos:
additional_dependencies: [flake8-docstrings]
- repo: https://github.com/PyCQA/bandit
rev: '1.7.1' # Use the sha / tag you want to point at
rev: '1.7.4' # Use the sha / tag you want to point at
hooks:
- id: bandit
args: ['--skip', 'B404,B506,B410,B603,B604', '--level', 'LOW']
@ -45,13 +45,20 @@ repos:
- id: isort
- repo: https://codeberg.org/frnmst/licheck
rev: 0.0.3
rev: 1.0.0
hooks:
- id: licheck
args: ['--configuration-file', '.allowed_licenses.yml']
- repo: https://codeberg.org/frnmst/md-toc
rev: '8.1.3' # or a specific git tag from md-toc
hooks:
- id: md-toc
args: [-p, 'cmark', '-l6'] # CLI options
exclude: README.md
- repo: https://github.com/mgedmin/check-manifest
rev: "0.47"
rev: "0.48"
hooks:
- id: check-manifest
args: ['--ignore','docs/*,docs/assets/*,Pipfile,Makefile,fpyutils/tests/*,packages/aur/*']

3
CONTRIBUTING.md

@ -0,0 +1,3 @@
# Contributing
See https://docs.franco.net.eu.org/md-toc/contributing.html

4
MANIFEST.in

@ -1,6 +1,6 @@
global-include LICENSE.txt
global-include README.rst
global-include CONTRIBUTING.rst
global-include README.md
global-include CONTRIBUTING.md
exclude *.yaml
exclude *.yml
recursive-exclude assets *

2
Makefile

@ -2,7 +2,7 @@
#
# Makefile
#
# Copyright (C) 2017-2020 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
# Copyright (C) 2017-2022 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
#
# This file is part of fpyutils.
#

60
README.md

@ -0,0 +1,60 @@
# fpyutils
[![PyPI fpyutils version](https://img.shields.io/pypi/v/fpyutils.svg)](https://pypi.org/project/fpyutils/)
[![PyPI - License](https://img.shields.io/pypi/l/fpyutils.svg?color=blue)](https://raw.githubusercontent.com/frnmst/fpyutils/master/LICENSE.txt)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fpyutils.svg)
[![Downloads](https://pepy.tech/badge/fpyutils)](https://pepy.tech/project/fpyutils)
[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/fpyutils.svg)](https://libraries.io/pypi/fpyutils/dependents)
[![Buy me a coffee](assets/buy_me_a_coffee.svg)](https://buymeacoff.ee/frnmst)
A collection of useful non-standard Python functions which aim to be
simple to use, highly readable but not efficient.
<!--TOC-->
## Documentation
<https://docs.franco.net.eu.org/fpyutils/>
## API examples
```python
>>> import fpyutils
>>> f = open('foo.txt')
>>> f.read()
"This is\nfoo.\nfoo\nThis is\nnot\nbar.\nAnd it's\n foo\n\nBye!\n"
>>> fpyutils.filelines.get_line_matches('foo.txt','foo',5)
{1: 3, 2: 8}
```
## License
Copyright (C) 2017-2022 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
fpyutils is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
fpyutils is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along
with fpyutils. If not, see \<<http://www.gnu.org/licenses/>\>.
## Changelog and trusted source
You can check the authenticity of new releases using my public key.
Changelogs, instructions, sources and keys can be found at
[blog.franco.net.eu.org/software](https://blog.franco.net.eu.org/software/).
## Crypto donations
- Bitcoin: bc1qnkflazapw3hjupawj0lm39dh9xt88s7zal5mwu
- Monero:
84KHWDTd9hbPyGwikk33Qp5GW7o7zRwPb8kJ6u93zs4sNMpDSnM5ZTWVnUp2cudRYNT6rNqctnMQ9NbUewbj7MzCBUcrQEY
- Dogecoin: DMB5h2GhHiTNW7EcmDnqkYpKs6Da2wK3zP
- Vertcoin: vtc1qd8n3jvkd2vwrr6cpejkd9wavp4ld6xfu9hkhh0

85
README.rst

@ -1,85 +0,0 @@
fpyutils
========
|pypiver| |license| |pyver| |downloads| |dependentrepos| |buymeacoffee|
.. |pypiver| image:: https://img.shields.io/pypi/v/fpyutils.svg
:alt: PyPI fpyutils version
:target: https://pypi.org/project/fpyutils/
.. |license| image:: https://img.shields.io/pypi/l/fpyutils.svg?color=blue
:alt: PyPI - License
:target: https://raw.githubusercontent.com/frnmst/fpyutils/master/LICENSE.txt
.. |pyver| image:: https://img.shields.io/pypi/pyversions/fpyutils.svg
:alt: PyPI - Python Version
.. |downloads| image:: https://pepy.tech/badge/fpyutils
:alt: Downloads
:target: https://pepy.tech/project/fpyutils
.. |dependentrepos| image:: https://img.shields.io/librariesio/dependent-repos/pypi/fpyutils.svg
:alt: Dependent repos (via libraries.io)
:target: https://libraries.io/pypi/fpyutils/dependents
.. |buymeacoffee| image:: assets/buy_me_a_coffee.svg
:alt: Buy me a coffee
:target: https://buymeacoff.ee/frnmst
A collection of useful non-standard Python functions which aim to be simple to
use, highly readable but not efficient.
Documentation
-------------
https://docs.franco.net.eu.org/fpyutils/
API examples
------------
::
>>> import fpyutils
>>> f = open('foo.txt')
>>> f.read()
"This is\nfoo.\nfoo\nThis is\nnot\nbar.\nAnd it's\n foo\n\nBye!\n"
>>> fpyutils.filelines.get_line_matches('foo.txt','foo',5)
{1: 3, 2: 8}
.. _public API: https://docs.franco.net.eu.org/fpyutils/api.html
License
-------
Copyright (C) 2017-2021 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
fpyutils is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
fpyutils is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with fpyutils. If not, see <http://www.gnu.org/licenses/>.
Changelog and trusted source
----------------------------
You can check the authenticity of new releases using my public key.
Changelogs, instructions, sources and keys can be found at `blog.franco.net.eu.org/software <https://blog.franco.net.eu.org/software/>`_.
Crypto donations
----------------
- Bitcoin: bc1qnkflazapw3hjupawj0lm39dh9xt88s7zal5mwu
- Monero: 84KHWDTd9hbPyGwikk33Qp5GW7o7zRwPb8kJ6u93zs4sNMpDSnM5ZTWVnUp2cudRYNT6rNqctnMQ9NbUewbj7MzCBUcrQEY
- Dogecoin: DMB5h2GhHiTNW7EcmDnqkYpKs6Da2wK3zP
- Vertcoin: vtc1qd8n3jvkd2vwrr6cpejkd9wavp4ld6xfu9hkhh0

6
docs/conf.py

@ -54,7 +54,7 @@ master_doc = 'index'
# General information about the project.
project = 'fpyutils'
copyright = '2017-2021, Franco Masotti'
copyright = '2017-2022, Franco Masotti'
author = 'Franco Masotti'
# The version info for the project you're documenting, acts as replacement for
@ -62,9 +62,9 @@ author = 'Franco Masotti'
# built documents.
#
# The short X.Y version.
version = '2.1.0'
version = '2.2.0'
# The full version, including alpha/beta/rc tags.
release = '2.1.0'
release = '2.2.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

2
docs/contributing.rst

@ -1,4 +1,4 @@
Contributing
============
`Contributing [common] <https://docs.franco.net.eu.org/fpydocs/contributing_common.html>`_ version `4.1.2 <https://software.franco.net.eu.org/frnmst/fpydocs/src/tag/4.1.2>`_
`Contributing [common] <https://docs.franco.net.eu.org/fpydocs/contributing_common.html>`_ version `4.3.0 <https://software.franco.net.eu.org/frnmst/fpydocs/src/tag/4.3.0>`_

2
docs/copyright_license.rst

@ -1,7 +1,7 @@
Copyright and License
=====================
Copyright (C) 2017-2021 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
Copyright (C) 2017-2022 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
fpyutils is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

2
docs/workflow.rst

@ -1,4 +1,4 @@
Workflow
========
`Workflow [common] <https://docs.franco.net.eu.org/fpydocs/workflow_common.html>`_ version `4.1.2 <https://software.franco.net.eu.org/frnmst/fpydocs/src/tag/4.1.2>`_
`Workflow [common] <https://docs.franco.net.eu.org/fpydocs/workflow_common.html>`_ version `4.3.0 <https://software.franco.net.eu.org/frnmst/fpydocs/src/tag/4.3.0>`_

2
packages/aur/PKGBUILD

@ -1,7 +1,7 @@
# Maintainer: Franco Masotti <franco dot masotti at live dot com>
# Contributor: Franco Masotti <franco dot masotti at live dot com>
pkgname=python-fpyutils
pkgver=2.1.0
pkgver=2.2.0
pkgrel=2
pkgdesc="A collection of useful non-standard Python functions which aim to be simple to use"
arch=('any')

9
setup.py

@ -22,14 +22,17 @@
from setuptools import find_packages, setup
with open('README.md', 'r', encoding='utf-8') as f:
readme = f.read()
setup(
name='fpyutils',
version='2.1.0',
version='2.2.0',
packages=find_packages(exclude=['*tests*']),
license='GPLv3+',
description='A collection of useful non-standard Python functions which aim to be simple to use, highly readable but not efficient.',
long_description=open('README.rst').read(),
long_description_content_type='text/x-rst',
long_description=readme,
long_description_content_type='text/markdown',
package_data={
'': ['*.txt', '*.rst'],
},

Loading…
Cancel
Save