Skip to content

Commit

Permalink
Merge pull request #116 from sepandhaghighi/dev
Browse files Browse the repository at this point in the history
Version 4.6
  • Loading branch information
sepandhaghighi authored Mar 30, 2020
2 parents a4cb929 + de7db06 commit a4545ed
Show file tree
Hide file tree
Showing 28 changed files with 4,132 additions and 1,338 deletions.
31 changes: 25 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ Please consider the following :
3. Add your new features or fix detected bugs
- To add a new font visit [here](#font)
- To add a new 1-line art visit [here](#1-line-art)
- To add a new decoration visit [here](#decoration)
4. Add standard `docstring` to your functions
5. Add tests for new features (`doctest`)
- **Non-ASCII** fonts in `test2.py`
- Other in `test.py`
- **ASCII** fonts/arts in `test.py`
- Other in `test2.py`
6. Update `README.md` (if needed)
7. Pass all CI tests
8. Update `CHANGELOG.md`
Expand Down Expand Up @@ -59,10 +60,28 @@ Please consider the following :
4. If 1-line art is bipartite:
- Add as list (Example : ```"1-line art name": ["string1","string1"]```)
- Add 1-line art name to `RANDOM_FILTERED_ARTS` list
5. Add a test case to `test.py` (*Alphabetical order*)
6. Re-run `ArtList.ipynb`
5. If 1-line art is **Non-ASCII**:
- Add 1-line art name to `NON_ASCII_ARTS` list
- Add a test case to `test2.py` (*Alphabetical order*)
6. If 1-line art is **ASCII**:
- Add a test case to `test.py` (*Alphabetical order*)
- Add 1-line art name to `RANDOM_FILTERED_ARTS` list to remove it from random mode (*Optional*)
7. Re-run `ArtList.ipynb`
- Before this step you should re-install `art` package : ```python setup.py install```
8. Update 2 art counters in `README.md`
- Badge section
- Overview section
9. Update `Reference` section in `README.md`

## Decoration

1. Select a non-duplicate name
2. Add new decoration data as a list to the end of `decor_dic.py`
3. Map decoration name and data in `DECORATIONS_MAP` dictionary
4. Add a test case to `test2.py` (*Alphabetical order*)
5. Re-run `DecorList.ipynb`
- Before this step you should re-install `art` package : ```python setup.py install```
7. Update 2 art counters in `README.md`
6. Update 2 decor counters in `README.md`
- Badge section
- Overview section
8. Update `Reference` section in `README.md`
7. Update `Reference` section in `README.md`
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ matrix:
- os: linux
python: 2.7
include:
- os: linux
python: 3.8
dist: xenial
- os: linux
python: 3.7
dist: xenial
Expand Down
5 changes: 3 additions & 2 deletions .travis/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ then
PYTHON_COMMAND=python3
PIP_COMMAND=pip3
fi

$PIP_COMMAND install -r requirements.txt

$PYTHON_COMMAND setup.py install
$PYTHON_COMMAND -m art test
$PYTHON_COMMAND -m art test2
$PYTHON_COMMAND -m art testcov
$PYTHON_COMMAND -m art testcov2

if [ "$TRAVIS_OS_NAME" == "osx" ]
then
Expand Down
10 changes: 8 additions & 2 deletions ArtList.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Version : 4.5"
"### Version : 4.6"
]
},
{
Expand Down Expand Up @@ -1540,7 +1540,13 @@
"(:) \n",
"******************************\n",
"victory\n",
"V(-.o)V \n",
"V(-.o)V \n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"******************************\n",
"volcano1\n",
"/\"\\ \n",
Expand Down
58 changes: 57 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,61 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [4.6] - 2020-03-30
### Added
- `NON_ASCII_ARTS` list
- `decor_dic.py` file
- `codecov.yml` file
- `decor` function
- `decor_list` function
- `DecorList.ipynb` notebook
- 10 new decorations
1. barcode1
2. champion1
3. chess1
4. lucky1
5. sad1
6. soccer1
7. star1
8. star2
9. wave1
10. wave2
- 20 new fonts
1. scammer
2. strikethrough
3. drako
4. celtic
5. fasion
6. curly
7. russian
8. messletters
9. swirly
10. dotted
11. parenthesized
12. strange
13. wiggly
14. hazy
15. hyves
16. awcute
17. slammer
18. coptic1
19. coptic2
20. fancy108
### Changed
- `README.md` modified
- `CONTRIBUTING.md` modified
- MATLAB examples updated
- `setup.py` modified
- `coverage` dependency moved to `extras_require`
- Test system modified
- `random` mode modified
- `test` parameter removed from `font_list` function
- `mode` parameter added to `font_list` and `art_list` functions
- `decoration` parameter added to `text2art`, `tprint` and `tsave` functions
- `\n` support bug fixed
- `tsave` function bug in Windows fixed
### Removed
- `requirements.txt`
## [4.5] - 2020-01-29
### Added
- 35 new fonts
Expand Down Expand Up @@ -1359,7 +1414,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- 1-Line art
- CLI commands

[Unreleased]: https://github.com/sepandhaghighi/art/compare/v4.5...dev
[Unreleased]: https://github.com/sepandhaghighi/art/compare/v4.6...dev
[4.6]: https://github.com/sepandhaghighi/art/compare/v4.5...v4.6
[4.5]: https://github.com/sepandhaghighi/art/compare/v4.4...v4.5
[4.4]: https://github.com/sepandhaghighi/art/compare/v4.3...v4.4
[4.3]: https://github.com/sepandhaghighi/art/compare/v4.2...v4.3
Expand Down
135 changes: 135 additions & 0 deletions DecorList.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# ART"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Version : 4.6"
]
},
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"from art import *"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Decoration Counter"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"10"
]
},
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"DECORATION_COUNTER"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"⚠️ Some environments don't support all decorations"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Decoration List"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"barcode1\n",
"β–Œβ”‚β–ˆβ•‘β–Œβ•‘β–Œβ•‘ Ζ­Ξ΅ΰΈ£Ζ­ β•‘β–Œβ•‘β–Œβ•‘β–ˆβ”‚β–Œ\n",
"******************************\n",
"champion1\n",
"β—„[πŸ†]β–Ί Ζ­Ξ΅ΰΈ£Ζ­ β—„[πŸ₯‡]β–Ί\n",
"******************************\n",
"chess1\n",
"β–€β–„β–€β–„β–€β–„Ζ­Ξ΅ΰΈ£Ζ­β–„β–€β–„β–€β–„β–€\n",
"******************************\n",
"lucky1\n",
"πŸŒˆκ”£α¨ Ζ­Ξ΅ΰΈ£Ζ­ α¨κ”£πŸŒˆ\n",
"******************************\n",
"sad1\n",
"(-_-) Ζ­Ξ΅ΰΈ£Ζ­ (-_-)\n",
"******************************\n",
"soccer1\n",
"●●--β—β—β—„βš½οΈβ–Ί Ζ­Ξ΅ΰΈ£Ζ­ β—„βš½οΈβ–Ίβ—β—--●●\n",
"******************************\n",
"star1\n",
"γ€β˜…γ€‘ Ζ­Ξ΅ΰΈ£Ζ­ γ€β˜…γ€‘\n",
"******************************\n",
"star2\n",
"β˜…Β·.·´¯`Β·.Β·β˜… Ζ­Ξ΅ΰΈ£Ζ­ β˜…Β·.·´¯`Β·.Β·β˜…\n",
"******************************\n",
"wave1\n",
"▁ β–‚ β–„ β–… β–† β–‡ β–ˆΖ­Ξ΅ΰΈ£Ζ­β–ˆ β–‡ β–† β–… β–„ β–‚ ▁\n",
"******************************\n",
"wave2\n",
"β–‰β–‡β–†β–…β–„β–ƒβ–‚β–‚β–‚_Ζ­Ξ΅ΰΈ£Ζ­_β–‚β–‚β–ƒβ–„β–…β–†β–‡β–‰β–‰\n",
"******************************\n"
]
}
],
"source": [
"decor_list()"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.5.2"
}
},
"nbformat": 4,
"nbformat_minor": 2
}
Loading

0 comments on commit a4545ed

Please sign in to comment.