| Name | xfms-calculations JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | Perform calculations with ease |
| upload_time | 2024-02-08 17:35:54 |
| maintainer | |
| docs_url | None |
| author | Harsha |
| requires_python | >=3.6 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Make sure you have upgraded version of pip
Windows
```
py -m pip install --upgrade pip
```
Linux/MAC OS
```
python3 -m pip install --upgrade pip
```
## Create a project with the following structure
```
packaging_tutorial/
├── LICENSE
├── pyproject.toml
├── README.md
├── setup.cfg
├── src/
│ └── example_package/
│ ├── __init__.py
│ └── example.py
└── tests/
touch LICENSE
touch pyproject.toml
touch setup.cfg
mkdir src/mypackage
touch src/mypackage/__init__.py
touch src/mypackage/main.py
mkdir tests
```
## pyproject.toml
This file tells tools like pip and build how to create your project
```
[build-system]
requires = [
"setuptools>=42",
"wheel"
]
build-backend = "setuptools.build_meta"
```
build-system.requires gives a list of packages that are needed to build your package. Listing something here will only make it available during the build, not after it is installed.
build-system.build-backend is the name of Python object that will be used to perform the build. If you were to use a different build system, such as flit or poetry, those would go here, and the configuration details would be completely different than the setuptools configuration described below.
# Setup.cfg setup
Using setup.cfg is a best practice, but you could have a dynamic setup file using setup.py
```
[metadata]
name = example-pkg-YOUR-USERNAME-HERE
version = 0.0.1
author = Example Author
author_email = author@example.com
description = A small example package
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/pypa/sampleproject
project_urls =
Bug Tracker = https://github.com/pypa/sampleproject/issues
classifiers =
Programming Language :: Python :: 3
License :: OSI Approved :: MIT License
Operating System :: OS Independent
[options]
package_dir =
= src
packages = find:
python_requires = >=3.6
[options.packages.find]
where = src
```
# Running the build
### Make sure your build tool is up to date
Windows
```
py -m pip install --upgrade build
```
Linux/MAC OS
```
python3 -m pip install --upgrade build
```
### Create the build
```
py -m build
```
### References
https://packaging.python.org/tutorials/packaging-projects/
Raw data
{
"_id": null,
"home_page": "",
"name": "xfms-calculations",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Harsha",
"author_email": "harshanit400@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/41/ba/b7d19dbfa83408169e17346f19eb5d0a481e24aed8cef981de9356c70f85/xfms-calculations-0.0.2.tar.gz",
"platform": null,
"description": "\r\n# Make sure you have upgraded version of pip\r\nWindows\r\n```\r\npy -m pip install --upgrade pip\r\n```\r\n\r\nLinux/MAC OS\r\n```\r\npython3 -m pip install --upgrade pip\r\n```\r\n\r\n## Create a project with the following structure\r\n```\r\npackaging_tutorial/\r\n\u251c\u2500\u2500 LICENSE\r\n\u251c\u2500\u2500 pyproject.toml\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 setup.cfg\r\n\u251c\u2500\u2500 src/\r\n\u2502 \u2514\u2500\u2500 example_package/\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\u2502 \u2514\u2500\u2500 example.py\r\n\u2514\u2500\u2500 tests/\r\ntouch LICENSE\r\ntouch pyproject.toml\r\ntouch setup.cfg\r\nmkdir src/mypackage\r\ntouch src/mypackage/__init__.py\r\ntouch src/mypackage/main.py\r\nmkdir tests\r\n```\r\n\r\n## pyproject.toml \r\n\r\nThis file tells tools like pip and build how to create your project\r\n\r\n```\r\n[build-system]\r\nrequires = [\r\n \"setuptools>=42\",\r\n \"wheel\"\r\n]\r\nbuild-backend = \"setuptools.build_meta\"\r\n```\r\nbuild-system.requires gives a list of packages that are needed to build your package. Listing something here will only make it available during the build, not after it is installed.\r\n\r\nbuild-system.build-backend is the name of Python object that will be used to perform the build. If you were to use a different build system, such as flit or poetry, those would go here, and the configuration details would be completely different than the setuptools configuration described below.\r\n\r\n\r\n# Setup.cfg setup\r\nUsing setup.cfg is a best practice, but you could have a dynamic setup file using setup.py\r\n\r\n```\r\n[metadata]\r\nname = example-pkg-YOUR-USERNAME-HERE\r\nversion = 0.0.1\r\nauthor = Example Author\r\nauthor_email = author@example.com\r\ndescription = A small example package\r\nlong_description = file: README.md\r\nlong_description_content_type = text/markdown\r\nurl = https://github.com/pypa/sampleproject\r\nproject_urls =\r\n Bug Tracker = https://github.com/pypa/sampleproject/issues\r\nclassifiers =\r\n Programming Language :: Python :: 3\r\n License :: OSI Approved :: MIT License\r\n Operating System :: OS Independent\r\n\r\n[options]\r\npackage_dir =\r\n = src\r\npackages = find:\r\npython_requires = >=3.6\r\n\r\n[options.packages.find]\r\nwhere = src\r\n\r\n```\r\n# Running the build\r\n### Make sure your build tool is up to date\r\nWindows\r\n```\r\npy -m pip install --upgrade build\r\n```\r\nLinux/MAC OS\r\n```\r\npython3 -m pip install --upgrade build\r\n```\r\n\r\n\r\n### Create the build\r\n```\r\npy -m build\r\n```\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n### References\r\nhttps://packaging.python.org/tutorials/packaging-projects/\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Perform calculations with ease",
"version": "0.0.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d09fe687f7d0838f1e9598fbdd32a2e6967a535747d16b44a882d71d0fcf6cbd",
"md5": "764f557d18631b689c1083c066ce17d7",
"sha256": "cc4dd2a01315b64c63da5e83c294290ad6054c74c5f559c75eedfdf3589ddb7c"
},
"downloads": -1,
"filename": "xfms_calculations-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "764f557d18631b689c1083c066ce17d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 2734,
"upload_time": "2024-02-08T17:35:52",
"upload_time_iso_8601": "2024-02-08T17:35:52.750942Z",
"url": "https://files.pythonhosted.org/packages/d0/9f/e687f7d0838f1e9598fbdd32a2e6967a535747d16b44a882d71d0fcf6cbd/xfms_calculations-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41bab7d19dbfa83408169e17346f19eb5d0a481e24aed8cef981de9356c70f85",
"md5": "c3ed9b0de348d1a011c5edfd689f679f",
"sha256": "5d3701cc65692af01904d1030c00b93c65c51672260a8c724ed8fcf860b3b7bf"
},
"downloads": -1,
"filename": "xfms-calculations-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "c3ed9b0de348d1a011c5edfd689f679f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2234,
"upload_time": "2024-02-08T17:35:54",
"upload_time_iso_8601": "2024-02-08T17:35:54.936941Z",
"url": "https://files.pythonhosted.org/packages/41/ba/b7d19dbfa83408169e17346f19eb5d0a481e24aed8cef981de9356c70f85/xfms-calculations-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 17:35:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xfms-calculations"
}
