├── happy ├── __init__.py ├── constants.py ├── main.py └── functions.py ├── requirements.txt ├── .flake8 ├── .github ├── .DS_Store └── workflows │ ├── linting.yml │ ├── pypi-release.yml │ └── build.yml ├── media ├── example.png ├── happy.jpg └── old_example.png ├── .vscode └── settings.json ├── pyproject.toml ├── setup.py ├── CONTRIBUTING.md ├── README.md ├── .gitignore ├── poetry.lock ├── CODE_OF_CONDUCT.md └── LICENSE /happy/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | rich 2 | -------------------------------------------------------------------------------- /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 200 3 | ignore = 4 | W605 -------------------------------------------------------------------------------- /.github/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TechWiz-3/happy-jar-cli/HEAD/.github/.DS_Store -------------------------------------------------------------------------------- /media/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TechWiz-3/happy-jar-cli/HEAD/media/example.png -------------------------------------------------------------------------------- /media/happy.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TechWiz-3/happy-jar-cli/HEAD/media/happy.jpg -------------------------------------------------------------------------------- /media/old_example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TechWiz-3/happy-jar-cli/HEAD/media/old_example.png -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "python.linting.flake8Enabled": true, 3 | "python.linting.enabled": true 4 | } -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "happyjar" 3 | version = "4.0.1" 4 | description = "Keep a happy jar from your terminal" 5 | authors = ["TechWiz-3 "] 6 | license = "GPL-3.0" 7 | readme = "README.md" 8 | packages = [{include = "happy"}] 9 | 10 | [tool.poetry.dependencies] 11 | python = "^3.9" 12 | rich = "^12.6.0" 13 | 14 | [tool.poetry.group.dev.dependencies] 15 | flake8 = "^5.0.4" 16 | 17 | [build-system] 18 | requires = ["poetry-core"] 19 | build-backend = "poetry.core.masonry.api" 20 | 21 | [tool.poetry.scripts] 22 | happy = "happy.main:cli" 23 | -------------------------------------------------------------------------------- /happy/constants.py: -------------------------------------------------------------------------------- 1 | import os.path 2 | from rich.theme import Theme 3 | 4 | # happy jar path definitions 5 | HOME = os.path.expanduser("~") 6 | DATA_PATH = os.path.join(f"{HOME}/.happyjar.json") 7 | OLD_DATA_PATH = os.path.join(f"{HOME}/.happyjar.txt") 8 | 9 | THEME = Theme( 10 | { 11 | "info": "bold color(39)", 12 | "error": "bold red", 13 | "date": "bold color(111)", 14 | "message": "default", 15 | "tags": "bold color(141)", 16 | "warning": "italic dim yellow", 17 | } 18 | ) 19 | 20 | FLOWERS = ["🌼 ", "🍀 ", "🌻 ", "🌺 ", "🌹 ", "🌸 ", "🌷 ", "💐 ", "🏵️ "] 21 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | from pathlib import Path 3 | 4 | project_dir = Path(__file__).parent 5 | long_description = (project_dir / "README.md").read_text() 6 | 7 | setup( 8 | name="happyjar", 9 | url="https://github.com/TechWiz-3/happy-jar-cli", 10 | author="Zac the Wise aka TechWiz-3", 11 | version='4.0.1', 12 | description="Keep a happy jar from your terminal", 13 | long_description_content_type='text/markdown', 14 | long_description=long_description, 15 | packages=find_packages(), 16 | entry_points=''' 17 | [console_scripts] 18 | happy=happy.main:cli 19 | ''', 20 | install_requires=["rich"], 21 | ) 22 | -------------------------------------------------------------------------------- /.github/workflows/linting.yml: -------------------------------------------------------------------------------- 1 | name: Linting 2 | 3 | on: 4 | push: 5 | paths: 6 | - "**.py" 7 | pull_request: 8 | paths: 9 | - "**.py" 10 | 11 | jobs: 12 | flake8_lint: 13 | name: flake8 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - name: Checkout 18 | uses: actions/checkout@v3 19 | 20 | - name: Set up Python 3 21 | uses: actions/setup-python@v4 22 | with: 23 | python-version: '3.9' 24 | 25 | - name: Install flake8 26 | run: pip install flake8 27 | 28 | - name: Run flake8 29 | uses: suo/flake8-github-action@releases/v1 30 | with: 31 | checkName: 'flake8_lint' 32 | env: 33 | GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} 34 | -------------------------------------------------------------------------------- /.github/workflows/pypi-release.yml: -------------------------------------------------------------------------------- 1 | name: Release & Upload 2 | 3 | on: 4 | workflow_dispatch: 5 | release: 6 | types: [published] 7 | 8 | permissions: 9 | contents: read 10 | 11 | jobs: 12 | deploy: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout 17 | uses: actions/checkout@v3 18 | 19 | - name: Set up Python 3 20 | uses: actions/setup-python@v4 21 | with: 22 | python-version: '3.9' 23 | 24 | - name: Install dependencies 25 | run: | 26 | pip install -U pip 27 | pip install build 28 | 29 | - name: Build package 30 | run: python -m build 31 | 32 | - name: Upload binaries to release 33 | uses: svenstaro/upload-release-action@v2 34 | with: 35 | repo_token: ${{ secrets.GH_TOKEN }} 36 | file: dist/* 37 | tag: ${{ github.ref }} 38 | overwrite: true 39 | file_glob: true 40 | 41 | - name: Publish package 42 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 43 | with: 44 | user: ${{ secrets.PYPI_USERNAME }} 45 | password: ${{ secrets.PYPI_PASSWORD }} 46 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | First of all, thank you so much for taking a deeper look at the project. It does mean a lot. 4 | 5 | PRs and issues of all sorts are welcome, here are some guides to help you out. 6 | 7 | When contributing to this repository, preferably first discuess the changes you wish to implement via [GitHub Issues](https://github.com/TechWiz-3/happy-jar-cli/issues) page. 8 | 9 | If you're unure you to help, check out the `Todo` section of the project's README.md. 10 | 11 | Following the commit messages specified in [emoji-log](https://github.com/ahmadawais/Emoji-Log) is greatly appreciated (however not mandatory). You can use my [CLI tool](https://github.com/TechWiz-3/git-commit-emojis/) for commits if that's easier. 12 | 13 | All changes added must pass the CI tests (TBA) provided by the GitHub Actions workflows. If not, further changes must be done in order to make up for a valid pull request / merge request. If you need help because a test isn't passing, please open an issue :+1: 14 | 15 | When making the pull request, please ensure you tick `Allow edits by maintainers`. More info [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) 16 | 17 | We also have a [Code of Conduct](./CODE_OF_CONDUCT.md) in place so please make sure to follow the given set of guidelines and thresholds while you interact with the project! 18 | 19 | Contributors will receive recognition for their contributions to mankind (I mean this project) in the `Contributors` section of the `README.md`. You will also receive a nice title to describle your abilities and might open-source prowess. 20 | 21 | # Development Info 22 | 1. Clone the repo and cd into it 23 | 2. Ensure `poetry` is installed - `pip install poetry` 24 | 3. Run `poetry install` 25 | 4. Make whatever changes you need 26 | 5. To text changes run (in project root directory) `poetry run happy` 27 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build Python Binaries 2 | 3 | on: 4 | workflow_dispatch: # manual 5 | release: 6 | types: [published] # published releases only 7 | schedule: 8 | - cron: '0 0 1 * *' # once a month 9 | 10 | jobs: 11 | build_linux: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v3 15 | - name: Build Linux Binary 16 | uses: eric2788/pyinstaller-build@master 17 | with: 18 | main: happy/main 19 | artifact: happy 20 | use-dependencies: true 21 | - name: Upload Artifact 22 | uses: actions/upload-artifact@v2 23 | with: 24 | name: happy_linux 25 | path: dist 26 | 27 | build_windows: 28 | runs-on: windows-latest 29 | steps: 30 | - uses: actions/checkout@v3 31 | - name: Build Windows Exe 32 | uses: eric2788/pyinstaller-build@master 33 | with: 34 | main: happy/main 35 | artifact: happy 36 | use-dependencies: true 37 | - name: Upload Artifact 38 | uses: actions/upload-artifact@v2 39 | with: 40 | name: happy_windows 41 | path: dist 42 | 43 | build_macos: 44 | runs-on: macos-latest 45 | steps: 46 | # Check-out repository 47 | - uses: actions/checkout@v3 48 | # Setup Python 49 | - uses: actions/setup-python@v4 50 | with: 51 | python-version: '3.9' # Version range or exact version of a Python version to use, using SemVer's version range syntax 52 | architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified 53 | - name: Build MacOS Binary 54 | shell: bash 55 | run: | 56 | python -m pip install --upgrade pip 57 | pip install -r requirements.txt 58 | pip install pyinstaller 59 | pyinstaller -y --name happy --onefile "happy/main.py" 60 | chmod 770 "./dist" 61 | # Uploads artifact 62 | - name: Upload Artifact 63 | uses: actions/upload-artifact@v3 64 | with: 65 | name: happy_macos 66 | path: dist 67 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Happy Jar CLI 2 | An easy to use CLI for storing good memories and gratitiude. 3 | 4 | ```bash 5 | # basic logging 6 | $ happy log "Happy text here! :D" 7 | 8 | # view logs with 9 | $ happy get all 10 | 11 | # or, 12 | $ happy get today 13 | ``` 14 | 15 | ## Installation 16 | ```sh 17 | pip install happyjar 18 | ``` 19 | **Binaries:** 20 | Download the binary for your platform from the `Artifacts` section of the latest [GitHub Actions](https://github.com/TechWiz-3/happy-jar-cli/actions) run. 21 | 22 | ## What is it? 23 | 24 | [Source](https://twitter.com/imovesactive/status/1274960313863950337) 25 | 26 | ## Usage 27 | 28 | ```sh 29 | $ happy --help 30 | usage: happy [-h] {log,get} ... 31 | 32 | Log your good memories and gratitiude. 33 | 34 | positional arguments: 35 | {log,get} 36 | log logs an entry 37 | get gets entries 38 | 39 | optional arguments: 40 | -h, --help show this help message and exit 41 | 42 | examples: 43 | happy log "i am so happy because you starred this project's repo on github xDD" 44 | happy get all 45 | ``` 46 | 47 | ## Example 48 | 49 | 50 | 51 | Inspired by [michelle/happy](https://github.com/michelle/happy) 52 | 53 | ## Todo 54 | Check [Issues](https://github.com/TechWiz-3/happy-jar-cli/issues) for more. 55 | 56 | ### Development 57 | 58 | 1. Clone the repo and cd into it 59 | 2. Ensure `poetry` is installed - `pip install poetry` 60 | 3. Run `poetry install` 61 | 4. Make whatever changes you need 62 | 5. To text changes run (in project root directory) `poetry run happy` 63 | 64 | ## Contributors 65 | 66 | * [HitBlast](https://github.com/hitblast) the Mighty 67 | * [Diwash Dahal](https://github.com/diwash007) the Conqueror 68 | * [Franklin Ikeh](https://github.com/fr4nkln11) the Neat 69 | * [Micah Wood](https://github.com/mxw7265) the Strong 70 | * [Tanmay Patil](https://github.com/TanmayPatil105) the Admirable 71 | * [Rishabh Moharir](https://github.com/redromnon) the Noble 72 | 73 | --- 74 | ### 🎉 Commit labels 75 | If you're interested in the commit labels used in this repo, check out my [git commit emoji](https://github.com/TechWiz-3/git-commit-emojis) project 76 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | __pycache__/args.cpython-310.pyc 4 | *.py[cod] 5 | *$py.class 6 | 7 | # C extensions 8 | *.so 9 | 10 | # Distribution / packaging 11 | .Python 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | cover/ 54 | 55 | # Translations 56 | *.mo 57 | *.pot 58 | 59 | # Django stuff: 60 | *.log 61 | local_settings.py 62 | db.sqlite3 63 | db.sqlite3-journal 64 | 65 | # Flask stuff: 66 | instance/ 67 | .webassets-cache 68 | 69 | # Scrapy stuff: 70 | .scrapy 71 | 72 | # Sphinx documentation 73 | docs/_build/ 74 | 75 | # PyBuilder 76 | .pybuilder/ 77 | target/ 78 | 79 | # Jupyter Notebook 80 | .ipynb_checkpoints 81 | 82 | # IPython 83 | profile_default/ 84 | ipython_config.py 85 | 86 | # pyenv 87 | # For a library or package, you might want to ignore these files since the code is 88 | # intended to run in multiple environments; otherwise, check them in: 89 | # .python-version 90 | 91 | # pipenv 92 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 93 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 94 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 95 | # install all needed dependencies. 96 | #Pipfile.lock 97 | 98 | # poetry 99 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 100 | # This is especially recommended for binary packages to ensure reproducibility, and is more 101 | # commonly ignored for libraries. 102 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 103 | #poetry.lock 104 | 105 | # pdm 106 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 107 | #pdm.lock 108 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 109 | # in version control. 110 | # https://pdm.fming.dev/#use-with-ide 111 | .pdm.toml 112 | 113 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 114 | __pypackages__/ 115 | 116 | # Celery stuff 117 | celerybeat-schedule 118 | celerybeat.pid 119 | 120 | # SageMath parsed files 121 | *.sage.py 122 | 123 | # Environments 124 | .env 125 | .venv 126 | env/ 127 | venv/ 128 | ENV/ 129 | env.bak/ 130 | venv.bak/ 131 | 132 | # Spyder project settings 133 | .spyderproject 134 | .spyproject 135 | 136 | # Rope project settings 137 | .ropeproject 138 | 139 | # mkdocs documentation 140 | /site 141 | 142 | # mypy 143 | .mypy_cache/ 144 | .dmypy.json 145 | dmypy.json 146 | 147 | # Pyre type checker 148 | .pyre/ 149 | 150 | # pytype static type analyzer 151 | .pytype/ 152 | 153 | # Cython debug symbols 154 | cython_debug/ 155 | 156 | # PyCharm 157 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 158 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 159 | # and can be added to the global gitignore or merged into this file. For a more nuclear 160 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 161 | #.idea/ 162 | 163 | 164 | # Vim swap files 165 | *.swp 166 | .*.swp 167 | *~ 168 | .*~ 169 | -------------------------------------------------------------------------------- /poetry.lock: -------------------------------------------------------------------------------- 1 | [[package]] 2 | name = "commonmark" 3 | version = "0.9.1" 4 | description = "Python parser for the CommonMark Markdown spec" 5 | category = "main" 6 | optional = false 7 | python-versions = "*" 8 | 9 | [package.extras] 10 | test = ["flake8 (==3.7.8)", "hypothesis (==3.55.3)"] 11 | 12 | [[package]] 13 | name = "flake8" 14 | version = "5.0.4" 15 | description = "the modular source code checker: pep8 pyflakes and co" 16 | category = "dev" 17 | optional = false 18 | python-versions = ">=3.6.1" 19 | 20 | [package.dependencies] 21 | mccabe = ">=0.7.0,<0.8.0" 22 | pycodestyle = ">=2.9.0,<2.10.0" 23 | pyflakes = ">=2.5.0,<2.6.0" 24 | 25 | [[package]] 26 | name = "mccabe" 27 | version = "0.7.0" 28 | description = "McCabe checker, plugin for flake8" 29 | category = "dev" 30 | optional = false 31 | python-versions = ">=3.6" 32 | 33 | [[package]] 34 | name = "pycodestyle" 35 | version = "2.9.1" 36 | description = "Python style guide checker" 37 | category = "dev" 38 | optional = false 39 | python-versions = ">=3.6" 40 | 41 | [[package]] 42 | name = "pyflakes" 43 | version = "2.5.0" 44 | description = "passive checker of Python programs" 45 | category = "dev" 46 | optional = false 47 | python-versions = ">=3.6" 48 | 49 | [[package]] 50 | name = "Pygments" 51 | version = "2.13.0" 52 | description = "Pygments is a syntax highlighting package written in Python." 53 | category = "main" 54 | optional = false 55 | python-versions = ">=3.6" 56 | 57 | [package.extras] 58 | plugins = ["importlib-metadata"] 59 | 60 | [[package]] 61 | name = "rich" 62 | version = "12.6.0" 63 | description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal" 64 | category = "main" 65 | optional = false 66 | python-versions = ">=3.6.3,<4.0.0" 67 | 68 | [package.dependencies] 69 | commonmark = ">=0.9.0,<0.10.0" 70 | pygments = ">=2.6.0,<3.0.0" 71 | 72 | [package.extras] 73 | jupyter = ["ipywidgets (>=7.5.1,<8.0.0)"] 74 | 75 | [metadata] 76 | lock-version = "1.1" 77 | python-versions = "^3.9" 78 | content-hash = "f94e80e3bd9fe23fbb9deb3a6013b1cac50c8bf7ee447067bb3c11ac8fa074af" 79 | 80 | [metadata.files] 81 | commonmark = [ 82 | {file = "commonmark-0.9.1-py2.py3-none-any.whl", hash = "sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9"}, 83 | {file = "commonmark-0.9.1.tar.gz", hash = "sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60"}, 84 | ] 85 | flake8 = [ 86 | {file = "flake8-5.0.4-py2.py3-none-any.whl", hash = "sha256:7a1cf6b73744f5806ab95e526f6f0d8c01c66d7bbe349562d22dfca20610b248"}, 87 | {file = "flake8-5.0.4.tar.gz", hash = "sha256:6fbe320aad8d6b95cec8b8e47bc933004678dc63095be98528b7bdd2a9f510db"}, 88 | ] 89 | mccabe = [ 90 | {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"}, 91 | {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"}, 92 | ] 93 | pycodestyle = [ 94 | {file = "pycodestyle-2.9.1-py2.py3-none-any.whl", hash = "sha256:d1735fc58b418fd7c5f658d28d943854f8a849b01a5d0a1e6f3f3fdd0166804b"}, 95 | {file = "pycodestyle-2.9.1.tar.gz", hash = "sha256:2c9607871d58c76354b697b42f5d57e1ada7d261c261efac224b664affdc5785"}, 96 | ] 97 | pyflakes = [ 98 | {file = "pyflakes-2.5.0-py2.py3-none-any.whl", hash = "sha256:4579f67d887f804e67edb544428f264b7b24f435b263c4614f384135cea553d2"}, 99 | {file = "pyflakes-2.5.0.tar.gz", hash = "sha256:491feb020dca48ccc562a8c0cbe8df07ee13078df59813b83959cbdada312ea3"}, 100 | ] 101 | Pygments = [ 102 | {file = "Pygments-2.13.0-py3-none-any.whl", hash = "sha256:f643f331ab57ba3c9d89212ee4a2dabc6e94f117cf4eefde99a0574720d14c42"}, 103 | {file = "Pygments-2.13.0.tar.gz", hash = "sha256:56a8508ae95f98e2b9bdf93a6be5ae3f7d8af858b43e02c5a2ff083726be40c1"}, 104 | ] 105 | rich = [ 106 | {file = "rich-12.6.0-py3-none-any.whl", hash = "sha256:a4eb26484f2c82589bd9a17c73d32a010b1e29d89f1604cd9bf3a2097b81bb5e"}, 107 | {file = "rich-12.6.0.tar.gz", hash = "sha256:ba3a3775974105c221d31141f2c116f4fd65c5ceb0698657a11e9f295ec93fd0"}, 108 | ] 109 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual 10 | identity and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the overall 26 | community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or advances of 31 | any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email address, 35 | without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | [GitHub Issues](https://github.com/TechWiz-3/happy-jar-cli/issues). 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series of 86 | actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or permanent 93 | ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within the 113 | community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.1, available at 119 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at 126 | [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | -------------------------------------------------------------------------------- /happy/main.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # Happy jar cli, inspired by https://github.com/michelle/happy 3 | # Created by Zac the Wise 4 | # License: GPL-v3.0 5 | import argparse 6 | import re 7 | import textwrap 8 | from datetime import datetime 9 | from sys import argv, exit 10 | 11 | from rich.console import Console 12 | from rich.markdown import Markdown 13 | 14 | from happy.constants import THEME 15 | from happy.functions import read_file, write_file 16 | 17 | console = Console(highlight=False, theme=THEME) 18 | 19 | 20 | def cli() -> None: 21 | description = "Log your good memories and gratitiude." 22 | epilog = 'examples:\nhappy log "i am so happy because you starred this project\'s repo on github xDD"\n`happy get all`\n\nFor more help use `happy log --help` and `happy get --help`' 23 | parser = argparse.ArgumentParser( 24 | formatter_class=argparse.RawDescriptionHelpFormatter, 25 | description=description, 26 | epilog=textwrap.dedent(epilog), 27 | ) 28 | 29 | subparsers = parser.add_subparsers(dest="command") 30 | 31 | log = subparsers.add_parser("log", help="logs an entry") 32 | log.add_argument("log_entry", help="log message in quotes") 33 | log.add_argument( 34 | "--tag ", dest="tag", help="tags entry with specified tag", nargs="?" 35 | ) 36 | 37 | get = subparsers.add_parser("get", help="gets entries") 38 | get.add_argument("all", help="gets all entries", nargs="?") 39 | get.add_argument("today", help="gets today's entries", nargs="?") 40 | get.add_argument("week", help="gets the week's entries", nargs="?") 41 | get.add_argument("month", help="gets the months's entries", nargs="?") 42 | get.add_argument("before today", help="gets all entries before today", nargs="?") 43 | get.add_argument("random", help="gets a random entry", nargs="?") 44 | get.add_argument( 45 | "random ", help="gets specified number of random entries", nargs="?" 46 | ) 47 | get.add_argument( 48 | "", help="gets a specified date's entries with dd/mm/yyyy", nargs="?" 49 | ) 50 | get.add_argument( 51 | "count", help="displays how many times you were happy each day", nargs="?" 52 | ) 53 | get.add_argument( 54 | "tags", help="displays a list of all the tags used so far", nargs="?" 55 | ) 56 | get.add_argument("after ", help="gets all entries after a date", nargs="?") 57 | get.add_argument("before ", help="gets all entries before a date", nargs="?") 58 | get.add_argument( 59 | "tag ", help="gets only entries with specified tag", nargs="?" 60 | ) 61 | get.add_argument( 62 | "--flowers", help="adds a random flower to your entry 🌼", action="store_true" 63 | ) 64 | get.add_argument( 65 | "--nocolor", 66 | help="displays entries without any color formatting", 67 | action="store_true", 68 | ) 69 | 70 | args = parser.parse_args(argv[1:]) 71 | 72 | if not args.command: 73 | parser.print_help() 74 | exit() 75 | 76 | if args.command == "log": 77 | write_file(args.log_entry, args.tag) 78 | exit() 79 | 80 | if args.command == "get": 81 | 82 | def header(msg=""): 83 | console.rule(f"[bold]{msg}", style="bold color(105)", align="left") 84 | console.print("") 85 | 86 | footer = header 87 | 88 | if args.all == "tag" and args.today: 89 | tag = args.today 90 | console.print("") 91 | header("Entries tagged with " + tag) 92 | read_file(tag=tag, flowers=args.flowers, nocolor=args.nocolor) 93 | footer() 94 | 95 | # `happy get today` 96 | elif args.all == "today": 97 | console.print("") 98 | header("Today's Entries") 99 | read_file(today=True, flowers=args.flowers, nocolor=args.nocolor) 100 | footer() 101 | exit() 102 | 103 | # `happy get week` 104 | elif args.all == "week": 105 | console.print("") 106 | header("This Week's Entries") 107 | read_file(lastndays=True, days=7, flowers=args.flowers, nocolor=args.nocolor) 108 | footer() 109 | exit() 110 | 111 | # `happy get month` 112 | elif args.all == "month": 113 | console.print("") 114 | header("This Months's Entries") 115 | read_file(lastndays=True, days=30, flowers=args.flowers, nocolor=args.nocolor) 116 | footer() 117 | exit() 118 | 119 | # `happy get all` 120 | elif args.all == "all": 121 | console.print("") 122 | header("All Entries") 123 | read_file(flowers=args.flowers, nocolor=args.nocolor) 124 | footer() 125 | 126 | # `happy get random []` 127 | elif args.all == "random": 128 | console.print("") 129 | if args.today: 130 | try: 131 | random_num = int(args.today) 132 | header("Random Entries") 133 | read_file( 134 | random=random_num, flowers=args.flowers, nocolor=args.nocolor 135 | ) 136 | except ValueError: # a valid number wasn't provided 137 | console.print( 138 | Markdown("Error: please enter a valid number after `random` or `random` on it's own"), 139 | style="error",) 140 | print("") 141 | exit() 142 | else: 143 | header("Random Entry") 144 | read_file(random=1, flowers=args.flowers, nocolor=args.nocolor) 145 | footer() 146 | 147 | # `happy get count` 148 | elif args.all == "count": 149 | console.print("") 150 | header("Happyjar count") 151 | read_file(count=True, flowers=args.flowers, nocolor=args.nocolor) 152 | footer() 153 | 154 | # `happy get tags` 155 | elif args.all == "tags": 156 | console.print("") 157 | header("Tags") 158 | read_file(tags=True, flowers=args.flowers, nocolor=args.nocolor) 159 | footer() 160 | 161 | # `happy get [after|before|] 162 | else: 163 | # checks for after or until command 164 | if args.all == "after" or args.all == "before": 165 | date = args.today 166 | # uses current date if input is today 167 | if args.today == "today": 168 | date = datetime.now().strftime("%d/%m/%Y") 169 | else: 170 | date = args.all 171 | date_re = re.compile("^[0-9]{1,2}\/[0-9]{2}\/[0-9]{4}") 172 | console.print("") 173 | try: # get the date provided 174 | dt = re.match(date_re, date) 175 | except TypeError: 176 | # this triggers with the command 177 | # `happy get` without any other args 178 | console.print("Please use an argument after `get`\n", style="warning") 179 | get.print_help() # print usage for `get` 180 | else: 181 | if dt: 182 | if args.all == "before" or args.all == "after": 183 | header(f"Entries logged {args.all} {dt.group()}") 184 | else: 185 | header(f"Entries logged on {dt.group()}") 186 | read_file( 187 | date=dt.group(), 188 | flowers=args.flowers, 189 | after=args.all == "after", 190 | before=args.all == "before", 191 | nocolor=args.nocolor, 192 | ) 193 | footer() 194 | else: 195 | console.print( 196 | Markdown("Error: incorrect usage! If you are entering a date, use the format `dd/mm/yyyy`\n"), 197 | style="error", 198 | ) 199 | get.print_help() # print usage for `get` 200 | 201 | exit() 202 | 203 | 204 | if __name__ == "__main__": 205 | cli() 206 | -------------------------------------------------------------------------------- /happy/functions.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | from datetime import datetime, timedelta 4 | from random import choice, sample 5 | from sys import exit 6 | 7 | from rich.console import Console 8 | from rich.markdown import Markdown 9 | 10 | 11 | from happy.constants import DATA_PATH, OLD_DATA_PATH 12 | from happy.constants import THEME 13 | 14 | console = Console(highlight=False, theme=THEME) 15 | 16 | # stores the last flower used so 17 | # it can be skipped 18 | skip_flower = "" 19 | 20 | 21 | def write_file(entry, tag, time=None): 22 | """ 23 | logs are stored in a 'logs' array 24 | the logs array contains an object for each log 25 | each object contains the following 26 | day: day of the week 27 | date: dd/mm/yyyy 28 | time: h:mm AM/PM 29 | message: the actual log 30 | tags: array of tags 31 | """ 32 | 33 | file_init = {"logs": []} # initial state of .happyjar.json 34 | 35 | if tag: # check if --tag was used 36 | # add the tag to the entry text 37 | entry = entry + " #" + tag 38 | # the tag will be unpacked from the entry later 39 | if not time: # check if user did not specify time 40 | time = datetime.today() 41 | # format datetime to be 42 | # day&date&time 43 | try: 44 | time_str = time.strftime("%A&%-d/%b/%Y&%-I:%M %p") 45 | except ValueError: 46 | time_str = time.strftime("%A&%d/%b/%Y&%I:%M %p") 47 | # unpack datetime 48 | day, date, clock_time = time_str.split('&') 49 | 50 | # get tags passed into the message 51 | message, *tags = entry.split(" #") 52 | print(message, tags, *tags) 53 | 54 | payload = {"day": day, "date": date, "time": clock_time, "message": message, "tags": tags} 55 | 56 | if os.path.exists(DATA_PATH): # checks for an existing .json data_file 57 | try: 58 | with open(DATA_PATH, "+r") as happy_file: 59 | happy_data = json.load(happy_file) 60 | happy_data["logs"].append(payload) 61 | happy_file.seek(0) 62 | json.dump(happy_data, happy_file, indent=4) 63 | 64 | except Exception as err: 65 | console.print(f"Error occurred: {err}", style="error") 66 | else: 67 | console.print("\nEntry written successfully!\n", style="info") 68 | else: # migrate happyjar.txt to happyjar.json 69 | try: 70 | with open(DATA_PATH, "w") as happy_file: 71 | old_payload = [] 72 | if os.path.exists(OLD_DATA_PATH): # check if user has the old .txt file 73 | with open(OLD_DATA_PATH, 'r') as old_file: 74 | for line in old_file: 75 | line = line[:-1].split(": ") 76 | day, date, *time = line[0].split() 77 | time = ' '.join(time) 78 | message, *tags = line[1].split(" #") 79 | old_payload.append({"day": day, "date": date, "time": time, "message": message, "tags": tags}) 80 | file_init["logs"].extend(old_payload) # add data from .txt to the .json file first 81 | file_init["logs"].append(payload) 82 | json.dump(file_init, happy_file, indent=4) 83 | 84 | except Exception as err: 85 | console.print(f"Error occurred: {err}", style="error") 86 | else: 87 | console.print("\nJar created!\nEntry written successfully!\n", Markdown("Use `happy get all` or `happy get today` to view your logs!"), "", style="info") 88 | 89 | 90 | def display_entry(flowers, log, nocolor, string=False): 91 | """ 92 | displays entries with or without flowers 93 | --- 94 | flowers: is set to True or False 95 | log: entry object as a dict with date, day, tags and log 96 | nocolor: specifies entry output should be formatted with color 97 | string: specifies if the log is in string form which requires direct output 98 | """ 99 | 100 | global skip_flower # the last flower used 101 | flower_selection = ["🌼 ", "🍀 ", "🌻 ", "🌺 ", "🌹 ", "🌸 ", "🌷 ", "💐 ", "🏵️ "] 102 | 103 | if flowers: 104 | # randomly choose any flower except skip_flower to avoid repetition 105 | flower = choice([item for item in flower_selection if item != skip_flower]) 106 | skip_flower = flower 107 | else: 108 | flower = "" 109 | 110 | # display the output directly strings 111 | if string: 112 | console.print(f"{flower}{log}") 113 | return 114 | 115 | # extract data from log 116 | date = f"{log['day']} {log['date']} {log['time']}" 117 | entry = log['message'] 118 | tags = " ".join(f"#{tag}" for tag in log['tags']) 119 | 120 | # toggle whether to display colors or not 121 | toggle_style = ["date", "message", "tags"] 122 | if nocolor: 123 | toggle_style = ["default", "default", "default"] 124 | 125 | # print line 126 | console.print(f"{flower}[{toggle_style[0]}][{date}][/{toggle_style[0]}]: [{toggle_style[1]}]{entry}[/{toggle_style[1]}] [{toggle_style[2]}]{tags}[/{toggle_style[2]}]\n") 127 | 128 | 129 | def read_file( 130 | tag=None, 131 | date=False, 132 | today=False, 133 | lastndays=False, 134 | days=0, 135 | flowers=False, 136 | after=False, 137 | before=False, 138 | random=0, 139 | count=False, 140 | tags=False, 141 | nocolor=False, 142 | ): 143 | display = False 144 | if not os.path.exists(DATA_PATH): 145 | console.print("Error: your happyjar has not been initialised yet.", 146 | Markdown("To initialise your happyjar, log an entry using `happy log `."), "", 147 | Markdown("For more info use `happy log -h`"), "", style="error") 148 | exit() 149 | 150 | if today: 151 | time = datetime.today() 152 | try: 153 | today = time.strftime("%A %-d/%b/%Y") 154 | except ValueError: 155 | today = time.strftime("%A %d/%b/%Y") 156 | 157 | with open(DATA_PATH, "r") as happy_file: 158 | happy_data = json.load(happy_file) # converts json file to dictionary 159 | for log in happy_data['logs']: 160 | if f"{log['day']} {log['date']}" == today: 161 | display = True 162 | display_entry(flowers, log, nocolor) 163 | 164 | if lastndays: 165 | inital_time = datetime.today() - timedelta(days=days) 166 | 167 | with open(DATA_PATH, "r") as happy_file: 168 | happy_data = json.load(happy_file) # converts json file to dictionary 169 | for log in happy_data['logs']: 170 | date = log['date'] 171 | dt = datetime.strptime(date, "%d/%b/%Y") 172 | if dt > inital_time: 173 | display = True 174 | display_entry(flowers, log, nocolor) 175 | 176 | elif tag is not None: 177 | with open(DATA_PATH, "r") as happy_file: 178 | happy_data = json.load(happy_file) 179 | for log in happy_data['logs']: 180 | if tag in log['tags']: 181 | display = True 182 | display_entry(flowers, log, nocolor) 183 | 184 | elif date: 185 | try: # convert user inputted string to dt object 186 | converted_dt = datetime.strptime(date, "%d/%m/%Y") 187 | except ValueError: 188 | console.print("Error occurred converting date to date object", style="error") 189 | exit() 190 | else: 191 | try: 192 | # format dt object 193 | formatted_dt = datetime.strftime(converted_dt, "%-d/%b/%Y") 194 | except ValueError: 195 | # format dt object 196 | formatted_dt = datetime.strftime(converted_dt, "%d/%b/%Y") 197 | 198 | with open(DATA_PATH) as happy_file: 199 | happy_data = json.load(happy_file) 200 | for log in happy_data['logs']: 201 | # get the date of the line 202 | date = log['date'] 203 | dt = datetime.strptime(date, "%d/%b/%Y") 204 | if after: # `happy get after ` 205 | if dt > converted_dt: 206 | display = True 207 | display_entry(flowers, log, nocolor) 208 | elif before: # `happy get before ` 209 | if dt < converted_dt: 210 | display = True 211 | display_entry(flowers, log, nocolor) 212 | else: 213 | break 214 | else: # `happy get ` 215 | if date == formatted_dt: 216 | display = True 217 | display_entry(flowers, log, nocolor) 218 | 219 | elif random: # get a random entry 220 | with open(DATA_PATH) as happy_file: 221 | happy_data = json.load(happy_file) 222 | logs = happy_data['logs'] 223 | for log in sample(logs, min(random, len(logs))): 224 | display = True 225 | display_entry(flowers, log, nocolor) 226 | 227 | elif count: # get count of all entries per day 228 | map = {} # map to store the count of entries 229 | with open(DATA_PATH, "r") as happy_file: 230 | happy_data = json.load(happy_file) 231 | for log in happy_data['logs']: 232 | key = log['date'] 233 | # if the date hasn't already been added 234 | if key not in map.keys(): 235 | map[key] = 1 236 | else: # if date has been added 237 | map[key] += 1 # increment count 238 | for item in map: 239 | count = "" if map[item] == 1 else "s" # time/s 240 | output = f"You were happy {map[item]} time{count} on {item}\n" 241 | display = True 242 | display_entry(flowers, output, nocolor, string=True) 243 | 244 | elif tags: 245 | tags_list = [] 246 | with open(DATA_PATH, "r") as happy_file: 247 | happy_data = json.load(happy_file) 248 | for log in happy_data['logs']: 249 | tags_list.extend(log['tags']) 250 | tags_list = list(dict.fromkeys(tags_list)) # removing duplicates 251 | display = True 252 | tag_count = len(tags_list) 253 | if tag_count == 0: 254 | console.print("You have not used any tags so far", style="warning") 255 | elif tag_count == 1: 256 | console.print("You have used 1 tag so far") 257 | display_entry(flowers, f"{tags_list[0]}", nocolor, tags=True) 258 | else: 259 | console.print(f"You have used {tag_count} tags so far:") 260 | for tag in tags_list: 261 | display_entry(flowers, tag, nocolor, string=True) 262 | console.print("") 263 | 264 | else: # assume the whole file should be printed 265 | with open(DATA_PATH, "r") as happy_file: 266 | happy_data = json.load(happy_file) 267 | for log in happy_data['logs']: 268 | display = True 269 | display_entry(flowers, log, nocolor) 270 | if not display: # triggers if nothing was printed 271 | console.print("No entries for selected tag or time period\n", style="info") 272 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------