path: root/python-alfred-cli.spec

%global _empty_manifest_terminate_build 0
Name:		python-alfred-cli
Version:	1.2.0
Release:	1
Summary:	alfred is a building tool to make engineering tasks easier to develop and to maintain
License:	MIT
URL:		https://github.com/FabienArcellier/alfred-cli#alfred
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/79/6d/d361a38d352fb883a807abc0eec30329274f94932c86c50aacd022e9c801/alfred-cli-1.2.0.tar.gz
BuildArch:	noarch

Requires:	python3-click
Requires:	python3-plumbum
Requires:	python3-PyYAML
Requires:	python3-build
Requires:	python3-pylint
Requires:	python3-coverage
Requires:	python3-twine

%description
Ran 1 test in 0.000s
OK
```
### Customize a command for a specific OS
Alfred can run a specific part of the build for an OS,
for example to only run the linter on a linux machine.
```python
@alfred.command('ci', help="execute continuous integration process of alfred")
@alfred.option('-v', '--verbose', is_flag=True)
def ci(verbose: bool):
    if alfred.is_posix():
        alfred.invoke_command('lint', verbose=verbose)
    else:
        print("linter is not supported on non posix platform as windows")
    alfred.invoke_command('tests', verbose=verbose)
```
the ``alfred.is_posix``, ``alfred.is_linux``, ``alfred.is_macos``, ``alfred.is_windows`` functions allow you to quickly
target the environment on which specific processing must be performed.
## Developper guideline
```bash
pipenv install
pipenv shell
```
```
$ alfred
Usage: alfred [OPTIONS] COMMAND [ARGS]...
  alfred is a building tool to make engineering tasks easier to develop and to
  maintain
Options:
  -d, --debug  display debug information like command runned and working
               directory
  --help       Show this message and exit.
Commands:
  ci                 execute continuous integration process of alfred
  dist               build distribution packages
  lint               validate alfred using pylint on the package alfred
  publish            tag a new release and trigger pypi publication
  tests              validate alfred with all the automatic testing
  tests:acceptances  validate alfred with acceptances testing
  tests:units        validate alfred with unit testing
```
### Install development environment
Use make to instanciate a python virtual environment in ./venv and install the
python dependencies.
```bash
pipenv install --dev
```
### Install production environment
```bash
pipenv install
```
### Initiate or update the library requirements
If you want to initiate or update all the requirements `install_requires` declared in `setup.py`
and freeze a new `Pipfile.lock`, use this command
```bash
pipenv update
```
### Activate the python environment
When you setup the requirements, a `venv` directory on python 3 is created.
To activate the venv, you have to execute :
```bash
pipenv shell
```
### Run the linter and the unit tests
Before commit or send a pull request, you have to execute `pylint` to check the syntax
of your code and run the unit tests to validate the behavior.
```bash
alfred ci
```
## Contributors
* Fabien Arcellier
## License
MIT License
Copyright (c) 2021-2022 Fabien Arcellier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

%package -n python3-alfred-cli
Summary:	alfred is a building tool to make engineering tasks easier to develop and to maintain
Provides:	python-alfred-cli
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-alfred-cli
Ran 1 test in 0.000s
OK
```
### Customize a command for a specific OS
Alfred can run a specific part of the build for an OS,
for example to only run the linter on a linux machine.
```python
@alfred.command('ci', help="execute continuous integration process of alfred")
@alfred.option('-v', '--verbose', is_flag=True)
def ci(verbose: bool):
    if alfred.is_posix():
        alfred.invoke_command('lint', verbose=verbose)
    else:
        print("linter is not supported on non posix platform as windows")
    alfred.invoke_command('tests', verbose=verbose)
```
the ``alfred.is_posix``, ``alfred.is_linux``, ``alfred.is_macos``, ``alfred.is_windows`` functions allow you to quickly
target the environment on which specific processing must be performed.
## Developper guideline
```bash
pipenv install
pipenv shell
```
```
$ alfred
Usage: alfred [OPTIONS] COMMAND [ARGS]...
  alfred is a building tool to make engineering tasks easier to develop and to
  maintain
Options:
  -d, --debug  display debug information like command runned and working
               directory
  --help       Show this message and exit.
Commands:
  ci                 execute continuous integration process of alfred
  dist               build distribution packages
  lint               validate alfred using pylint on the package alfred
  publish            tag a new release and trigger pypi publication
  tests              validate alfred with all the automatic testing
  tests:acceptances  validate alfred with acceptances testing
  tests:units        validate alfred with unit testing
```
### Install development environment
Use make to instanciate a python virtual environment in ./venv and install the
python dependencies.
```bash
pipenv install --dev
```
### Install production environment
```bash
pipenv install
```
### Initiate or update the library requirements
If you want to initiate or update all the requirements `install_requires` declared in `setup.py`
and freeze a new `Pipfile.lock`, use this command
```bash
pipenv update
```
### Activate the python environment
When you setup the requirements, a `venv` directory on python 3 is created.
To activate the venv, you have to execute :
```bash
pipenv shell
```
### Run the linter and the unit tests
Before commit or send a pull request, you have to execute `pylint` to check the syntax
of your code and run the unit tests to validate the behavior.
```bash
alfred ci
```
## Contributors
* Fabien Arcellier
## License
MIT License
Copyright (c) 2021-2022 Fabien Arcellier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

%package help
Summary:	Development documents and examples for alfred-cli
Provides:	python3-alfred-cli-doc
%description help
Ran 1 test in 0.000s
OK
```
### Customize a command for a specific OS
Alfred can run a specific part of the build for an OS,
for example to only run the linter on a linux machine.
```python
@alfred.command('ci', help="execute continuous integration process of alfred")
@alfred.option('-v', '--verbose', is_flag=True)
def ci(verbose: bool):
    if alfred.is_posix():
        alfred.invoke_command('lint', verbose=verbose)
    else:
        print("linter is not supported on non posix platform as windows")
    alfred.invoke_command('tests', verbose=verbose)
```
the ``alfred.is_posix``, ``alfred.is_linux``, ``alfred.is_macos``, ``alfred.is_windows`` functions allow you to quickly
target the environment on which specific processing must be performed.
## Developper guideline
```bash
pipenv install
pipenv shell
```
```
$ alfred
Usage: alfred [OPTIONS] COMMAND [ARGS]...
  alfred is a building tool to make engineering tasks easier to develop and to
  maintain
Options:
  -d, --debug  display debug information like command runned and working
               directory
  --help       Show this message and exit.
Commands:
  ci                 execute continuous integration process of alfred
  dist               build distribution packages
  lint               validate alfred using pylint on the package alfred
  publish            tag a new release and trigger pypi publication
  tests              validate alfred with all the automatic testing
  tests:acceptances  validate alfred with acceptances testing
  tests:units        validate alfred with unit testing
```
### Install development environment
Use make to instanciate a python virtual environment in ./venv and install the
python dependencies.
```bash
pipenv install --dev
```
### Install production environment
```bash
pipenv install
```
### Initiate or update the library requirements
If you want to initiate or update all the requirements `install_requires` declared in `setup.py`
and freeze a new `Pipfile.lock`, use this command
```bash
pipenv update
```
### Activate the python environment
When you setup the requirements, a `venv` directory on python 3 is created.
To activate the venv, you have to execute :
```bash
pipenv shell
```
### Run the linter and the unit tests
Before commit or send a pull request, you have to execute `pylint` to check the syntax
of your code and run the unit tests to validate the behavior.
```bash
alfred ci
```
## Contributors
* Fabien Arcellier
## License
MIT License
Copyright (c) 2021-2022 Fabien Arcellier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

%prep
%autosetup -n alfred-cli-1.2.0

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-alfred-cli -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2.0-1
- Package Spec generated