A very simple library in Python to configure Make files.
## Table of contents
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)
## Installation
Python 3 is required to use this library.
Preffered way to install the library is to use pip:
```console
$ pip install smk-py # or
$ pip3 install smk-py
```
Installing from local would also work.
```console
$ git clone https://github.com/sahdjfg/smk-py --depth 1
$ cd smk-py
$ pip install . # or
$ pip3 install .
```
## Usage
```python
import smk
import platform # Local Python libraries can be imported
shell = smk.check("sh") # Checks if sh is available on the system path; returns None if not
echo = "echo"
if shell is None and platform.system() == "Windows":
# Use powershell
shell = "powershell"
else:
smk.error("sh is not available")
smk.feed([shell, echo]) # Feeds the Make file with variables
smk.setup() # Setups the Make file
```
## License
Everything in this repository is licensed under the Apache 2.0 license.
Raw data
{
"_id": null,
"home_page": "https://sahdjfg.github.io/smk-py",
"name": "smk-py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "maDeveloper",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/61/4f/c839009f5cf80d19640ec878159eb094f0a4a275c29918942d5d0c224c16/smk-py-1.2.5.tar.gz",
"platform": null,
"description": "A very simple library in Python to configure Make files.\n\n## Table of contents\n\n* [Installation](#installation)\n* [Usage](#usage)\n* [License](#license)\n\n## Installation\n\nPython 3 is required to use this library.\n\nPreffered way to install the library is to use pip:\n\n```console\n$ pip install smk-py # or\n$ pip3 install smk-py\n```\n\nInstalling from local would also work.\n\n```console\n$ git clone https://github.com/sahdjfg/smk-py --depth 1\n$ cd smk-py\n$ pip install . # or\n$ pip3 install .\n```\n\n## Usage\n\n\n```python\nimport smk\nimport platform # Local Python libraries can be imported\n\nshell = smk.check(\"sh\") # Checks if sh is available on the system path; returns None if not\necho = \"echo\"\n\nif shell is None and platform.system() == \"Windows\":\n # Use powershell\n shell = \"powershell\"\n\nelse:\n smk.error(\"sh is not available\")\n\nsmk.feed([shell, echo]) # Feeds the Make file with variables\nsmk.setup() # Setups the Make file\n```\n\n## License\n\nEverything in this repository is licensed under the Apache 2.0 license.\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A very simple library in Python to configure Make files",
"version": "1.2.5",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "2d1d361cbd99b403b5c4ed7708282691",
"sha256": "61a756646ddf698554127df65a34505576d299d3861c5931d862e09e98e3027d"
},
"downloads": -1,
"filename": "smk-py-1.2.5.tar.gz",
"has_sig": false,
"md5_digest": "2d1d361cbd99b403b5c4ed7708282691",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6496,
"upload_time": "2022-05-15T18:43:08",
"upload_time_iso_8601": "2022-05-15T18:43:08.487071Z",
"url": "https://files.pythonhosted.org/packages/61/4f/c839009f5cf80d19640ec878159eb094f0a4a275c29918942d5d0c224c16/smk-py-1.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-05-15 18:43:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "smk-py"
}
JSON