Skip to content

Commit

Permalink
Finalize package structure for development and setup release pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
StefanGreve committed Dec 16, 2021
1 parent e425c69 commit 07af725
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"MD013": false,
"MD033": false,
"MD041": false
}
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog

## Version 0.0.2 (16 Dec 2021)

Finalize package structure for development and setup release pipeline.

## Version 0.0.1 (16 Dec 2021)

Register package name of PyPI.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include *.md
include LICENSE
recursive-include requirements *.txt
exclude .markdownlint.json
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# iterfun
<h1 align="center">IterFun</h1>

<p align="center">
<a href="https://github.com/StefanGreve/iterfun/actions?query=workflow%3ACI" title="Continuous Integration" target="_blank">
<img src="https://github.com/StefanGreve/iterfun/actions/workflows/python-app.yml/badge.svg">
</a>
<a href="https://github.com/StefanGreve/iterfun" title="Release Version">
<img src="https://img.shields.io/pypi/v/iterfun?color=blue&label=Release">
</a>
<a title="Supported Python Versions">
<img src="https://img.shields.io/pypi/pyversions/iterfun">
</a>
<a href="https://www.gnu.org/licenses/gpl-3.0.en.html" title="License Information" target="_blank" rel="noopener noreferrer">
<img src="https://img.shields.io/badge/License-MIT-blue.svg">
</a>
<a title="Downloads per Month">
<img src="https://img.shields.io/pypi/dm/iterfun">
</a>
</p>

Implements an iterator interface reminscent of languages such as Elixier of F#.
4 changes: 2 additions & 2 deletions src/iterfun/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/usr/bin/env python3

from .iterfun import Iterator
from .iterfun import Iter

__version__ = "0.0.1"
__version__ = "0.0.2"
package_name = "iterfun"
python_major = "3"
python_minor = "7"
2 changes: 1 addition & 1 deletion src/iterfun/iterfun.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python3

class Iterator:
class Iter:
@staticmethod
def hello():
return "Hello, World!"
4 changes: 2 additions & 2 deletions tests/test_iterfun.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import unittest

from src.iterfun import Iterator
from src.iterfun import Iter

class TestIterator(unittest.TestCase):

def test_hello(self):
self.assertEqual("Hello, World!", Iterator.hello())
self.assertEqual("Hello, World!", Iter.hello())

0 comments on commit 07af725

Please sign in to comment.