# spasm -- SPorniket's tools for ASseMbly
> [WARNING] Please read carefully this note before using this project. It contains important facts.
Content
1. What is **spasm -- SPorniket's tools for ASseMbly**, and when to use it ?
2. What should you know before using **spasm -- SPorniket's tools for ASseMbly** ?
3. How to use **spasm -- SPorniket's tools for ASseMbly** ?
4. Known issues
5. Miscellanous
## 1. What is **spasm -- SPorniket's tools for ASseMbly**, and when to use it ?
**spasm -- SPorniket's tools for ASseMbly** is a collection of generic tools for assembly language, that should work for any Instruction Set Architecture (ISA).
### What's new in v1.0.0
**spasm_pp**
* Resolves #7 : [pp] 2 builtin styles and one used by default
* Resolves #8 : [pp] Support a provided stylesheet
* Resolves #9 : [pp][tech] Naming in the builtin structures
* Resolves #10 : [pp] Process a given list of files
* Resolves #11 : [pp] Replace input files by their formatted version if there is a difference
* Fixes #13 : [bug][pp] A special comment line starts with a doubled comment line mark
### What's new in v0.0.1
* Initial release : `spasm_pp` with fixed formatting.
### Licence
**spasm -- SPorniket's tools for ASseMbly** is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
**spasm -- SPorniket's tools for ASseMbly** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with **spasm -- SPorniket's tools for ASseMbly**.
If not, see http://www.gnu.org/licenses/ .
## 2. What should you know before using **spasm -- SPorniket's tools for ASseMbly** ?
> **SECURITY WARNING** : **spasm -- SPorniket's tools for ASseMbly** is a set of tools for manipulating files, and thus WILL allows attacks on the files systems. Do not install this project on servers.
**spasm -- SPorniket's tools for ASseMbly** is written in [Python](http://python.org) language, version 3.9 or above, and consists of :
* [spasm_pp](./README-pp.md) : the Pretty Printer.
> Do not use **spasm -- SPorniket's tools for ASseMbly** if this project is not suitable for your project
## 3. How to use **spasm -- SPorniket's tools for ASseMbly** ?
### Requirements
Python 3.8 or later versions, `pip3` and `pdm` are required.
### From source
To get the latest available code, one must clone the git repository, build and install to the maven local repository.
git clone https://github.com/sporniket/spasm.git
cd spasm
pdm build
sudo pip3 install dist/spasm_by_sporniket-<version>-py3-none-any.whl
### From Pypi
Add any of the following dependencies that are appropriate to your project.
```
sudo pip3 install spasm_by_sporniket
```
### Documentation
* [User manual of `spasm_pp`](./README-pp.md) ; [Specifications of custom stylesheet files](./README-pp--stylesheet.md)
## 4. Known issues
See the [project issues](https://github.com/sporniket/spasm/issues) page.
## 5. Miscellanous
### Report issues
Use the [project issues](https://github.com/sporniket/spasm/issues) page.
Raw data
{
"_id": null,
"home_page": "https://github.com/sporniket/spasm",
"name": "spasm-by-sporniket",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "assembler, pretty printer",
"author": null,
"author_email": "Sporniket <sporniket.studio@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/14/b3/22b0d4afd2858c85f47241516c63d9661895cb87406c0fcc16e6a5167e27/spasm_by_sporniket-1.0.0.tar.gz",
"platform": null,
"description": "# spasm -- SPorniket's tools for ASseMbly\n\n\n\n\n\n> [WARNING] Please read carefully this note before using this project. It contains important facts.\n\nContent\n\n1. What is **spasm -- SPorniket's tools for ASseMbly**, and when to use it ?\n2. What should you know before using **spasm -- SPorniket's tools for ASseMbly** ?\n3. How to use **spasm -- SPorniket's tools for ASseMbly** ?\n4. Known issues\n5. Miscellanous\n\n## 1. What is **spasm -- SPorniket's tools for ASseMbly**, and when to use it ?\n\n**spasm -- SPorniket's tools for ASseMbly** is a collection of generic tools for assembly language, that should work for any Instruction Set Architecture (ISA).\n\n### What's new in v1.0.0\n\n**spasm_pp**\n\n * Resolves #7 : [pp] 2 builtin styles and one used by default\n * Resolves #8 :\u00a0[pp] Support a provided stylesheet\n * Resolves #9 : [pp][tech] Naming in the builtin structures\n * Resolves #10 : [pp] Process a given list of files\n * Resolves #11 : [pp] Replace input files by their formatted version if there is a difference\n * Fixes #13 : [bug][pp] A special comment line starts with a doubled comment line mark\n\n### What's new in v0.0.1\n\n* Initial release : `spasm_pp` with fixed formatting.\n\n### Licence\n **spasm -- SPorniket's tools for ASseMbly** is free software: you can redistribute it and/or modify it under the terms of the\n GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your\n option) any later version.\n\n **spasm -- SPorniket's tools for ASseMbly** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without\n even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for\n more details.\n\n You should have received a copy of the GNU General Public License along with **spasm -- SPorniket's tools for ASseMbly**.\n If not, see http://www.gnu.org/licenses/ .\n\n\n## 2. What should you know before using **spasm -- SPorniket's tools for ASseMbly** ?\n\n> **SECURITY WARNING** :\u00a0**spasm -- SPorniket's tools for ASseMbly** is a set of tools for manipulating files, and thus WILL\u00a0allows attacks on the files systems. Do not install this project on servers.\n\n**spasm -- SPorniket's tools for ASseMbly** is written in [Python](http://python.org) language, version 3.9 or above, and consists of :\n\n* [spasm_pp](./README-pp.md) : the Pretty Printer.\n\n> Do not use **spasm -- SPorniket's tools for ASseMbly** if this project is not suitable for your project\n\n## 3. How to use **spasm -- SPorniket's tools for ASseMbly** ?\n\n### Requirements\n\nPython 3.8 or later versions, `pip3` and `pdm` are required.\n\n### From source\n\nTo get the latest available code, one must clone the git repository, build and install to the maven local repository.\n\n\tgit clone https://github.com/sporniket/spasm.git\n\tcd spasm\n\tpdm build\n sudo pip3 install dist/spasm_by_sporniket-<version>-py3-none-any.whl\n\n### From Pypi\nAdd any of the following dependencies that are appropriate to your project.\n\n```\nsudo pip3 install spasm_by_sporniket\n```\n\n### Documentation\n\n* [User manual of `spasm_pp`](./README-pp.md) ; [Specifications of custom stylesheet files](./README-pp--stylesheet.md)\n\n## 4. Known issues\nSee the [project issues](https://github.com/sporniket/spasm/issues) page.\n\n## 5. Miscellanous\n\n### Report issues\nUse the [project issues](https://github.com/sporniket/spasm/issues) page.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Sporniket's toolbox for assembly language",
"version": "1.0.0",
"project_urls": {
"Bug-tracker": "https://github.com/sporniket/spasm/issues",
"Homepage": "https://github.com/sporniket/spasm",
"Repository": "https://github.com/sporniket/spasm"
},
"split_keywords": [
"assembler",
" pretty printer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ac0b6d48377adf5d4ab23fda6d1e8eee59111d5f834619a7926f28d9122ff1e",
"md5": "191b44a0c791743efc53bfc326713d5a",
"sha256": "6cbb163f669ff1b02816b160bcf38a336c8ec15dcc3a7685c3bec94ecf50e61b"
},
"downloads": -1,
"filename": "spasm_by_sporniket-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "191b44a0c791743efc53bfc326713d5a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21276,
"upload_time": "2024-08-23T21:37:37",
"upload_time_iso_8601": "2024-08-23T21:37:37.380615Z",
"url": "https://files.pythonhosted.org/packages/4a/c0/b6d48377adf5d4ab23fda6d1e8eee59111d5f834619a7926f28d9122ff1e/spasm_by_sporniket-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14b322b0d4afd2858c85f47241516c63d9661895cb87406c0fcc16e6a5167e27",
"md5": "b3eab2417ee164662832c7b2b91fb22a",
"sha256": "b93250859ff001e20a0bda8b1b29cd9ad2456d649cf89ee018e43d20486aa17b"
},
"downloads": -1,
"filename": "spasm_by_sporniket-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b3eab2417ee164662832c7b2b91fb22a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20202,
"upload_time": "2024-08-23T21:37:38",
"upload_time_iso_8601": "2024-08-23T21:37:38.528361Z",
"url": "https://files.pythonhosted.org/packages/14/b3/22b0d4afd2858c85f47241516c63d9661895cb87406c0fcc16e6a5167e27/spasm_by_sporniket-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 21:37:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sporniket",
"github_project": "spasm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spasm-by-sporniket"
}
JSON
