https://github.com/benmaier/bfmdummypackage
A dummy package that contains the structure I use for Python packages.
https://github.com/benmaier/bfmdummypackage
Last synced: 3 months ago
JSON representation
A dummy package that contains the structure I use for Python packages.
- Host: GitHub
- URL: https://github.com/benmaier/bfmdummypackage
- Owner: benmaier
- License: mit
- Created: 2021-08-24T08:53:31.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-26T13:02:04.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T11:08:03.972Z (8 months ago)
- Language: Python
- Size: 1.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
*Note: This is a dummy README for the package you want to build. For a README for the package builder, check out
[PACKAGE_CREATION_README.md](https://github.com/benmaier/bfmdummypackage/blob/main/PACKAGE_CREATION_README.md)*
[](https://circleci.com/gh/benmaier/bfmdummypackage)
Description of this package goes here.
* repository: https://github.com/benmaier/bfmdummypackage/
* documentation: http://bfmdummypackage.benmaier.org/
```python
from bfmdummypackage.sqrt import get_sqrt_2
print(get_sqrt_2())
```
## Install
pip install bfmdummypackage
`bfmdummypackage` was developed and tested for
* Python 3.6
* Python 3.7
* Python 3.8
So far, the package's functionality was tested on Mac OS X and CentOS only.
## Dependencies
`bfmdummypackage` directly depends on the following packages which will be installed by `pip` during the installation process
* `numpy>=1.17`
## Documentation
The full documentation is available at [bfmdummypackage.benmaier.org](http://bfmdummypackage.benmaier.org).
## Changelog
Changes are logged in a [separate file](https://github.com/benmaier/bfmdummypackage/blob/main/CHANGELOG.md).
## License
This project is licensed under the [MIT License](https://github.com/benmaier/bfmdummypackage/blob/main/LICENSE).
Note that this excludes any images/pictures/figures shown here or in the documentation.
## Contributing
If you want to contribute to this project, please make sure to read the [code of conduct](https://github.com/benmaier/bfmdummypackage/blob/main/CODE_OF_CONDUCT.md) and the [contributing guidelines](https://github.com/benmaier/bfmdummypackage/blob/main/CONTRIBUTING.md). In case you're wondering about what to contribute, we're always collecting ideas of what we want to implement next in the [outlook notes](https://github.com/benmaier/bfmdummypackage/blob/main/OUTLOOK.md).
[](code-of-conduct.md)
## Dev notes
Fork this repository, clone it, and install it in dev mode.
```bash
git clone [email protected]:YOURUSERNAME/bfmdummypackage.git
make
```
If you want to upload to PyPI, first convert the new `README.md` to `README.rst`
```bash
make readme
```
It will give you warnings about bad `.rst`-syntax. Fix those errors in `README.rst`. Then wrap the whole thing
```bash
make pypi
```
It will probably give you more warnings about `.rst`-syntax. Fix those until the warnings disappear. Then do
```bash
make upload
```