acintellisense


Nameacintellisense JSON
Version 1.1.1 PyPI version JSON
download
home_pageNone
SummaryAssetto Corsa intellisense stubs helper
upload_time2024-10-16 20:09:36
maintainerNone
docs_urlNone
authorRipRock
requires_pythonNone
licenseNone
keywords python ac assetto corsa dummy stub
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Assetto Intellisense
Library containing fuction stubs to help with Assetto Corsa mod development when using an IDE

Helps internal intellisense to know function calls with types.

This recreates the `ac` module with currently known stubs



Python Pacakage: 
## Installation to develop AC mod

You will need to install the package in your environment:
```shell
pip install acintellisense
```

Now if your PyCharm project is accessible to this package,
after `import ac`, you should be able to use autocomplete.

Now you can check your IDE, autocomplete should work.

## Note
I dont know why vscode intellisense has a hard time but I had to make the .vscode/settings.json file that contains 
```
{
    "python.analysis.extraPaths": ["./"]
}
```

If anyone knows how to fix it so this is not required please let me know

## Contribution
Please submit issues/pull requests if there is something missing, documentation inaccuracy, or a revision
I am trying to keep this as up to date as possible to help in mod development

Any and all work on this is appreciated! 

For a list of functions missing documetation: [Missing Functions](missing_functions.md)

## References
#### Thank yous/Credits:
[rikby/ac-stubs](https://github.com/rikby/ac-stubs) - These guys did a bunch of the heavy lifting by getting all the function stubs. I just modified it and documented it. The only reason why this repository exists is that its been over a year since that repository was updated and I saw that there was still room to imporve on it and with the pull request I made remaing open, I decided to create this to continue its inital purpose by helping modders when it comes to IDE intellisense

#### Source documents:
- https://docs.google.com/document/d/13trBp6K1TjWbToUQs_nfFsB291-zVJzRZCNaTYt4Dzc/pub
- https://assettocorsamods.net/attachments/inofficial_acpythondoc_v2-pdf.7415/
- https://www.assettocorsa.net/forum/index.php?threads/python-doc-update-25-05-2017.517/

#### Initial forum threads:
- https://assettocorsamods.net/threads/doc-python-doc.59
- https://assettocorsamods.net/threads/is-there-a-way-to-load-ac-library-to-have-autocomplete-in-an-ide-e-g-pycharm.3088/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "acintellisense",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "python, AC, Assetto Corsa, dummy, stub",
    "author": "RipRock",
    "author_email": "<me@riprock.tech>",
    "download_url": "https://files.pythonhosted.org/packages/8e/17/d6afd6e76190701288ecc93a81166d2c101a1bb646a62b075ffe5e5281b5/acintellisense-1.1.1.tar.gz",
    "platform": null,
    "description": "# Assetto Intellisense\nLibrary containing fuction stubs to help with Assetto Corsa mod development when using an IDE\n\nHelps internal intellisense to know function calls with types.\n\nThis recreates the `ac` module with currently known stubs\n\n\n\nPython Pacakage: \n## Installation to develop AC mod\n\nYou will need to install the package in your environment:\n```shell\npip install acintellisense\n```\n\nNow if your PyCharm project is accessible to this package,\nafter `import ac`, you should be able to use autocomplete.\n\nNow you can check your IDE, autocomplete should work.\n\n## Note\nI dont know why vscode intellisense has a hard time but I had to make the .vscode/settings.json file that contains \n```\n{\n    \"python.analysis.extraPaths\": [\"./\"]\n}\n```\n\nIf anyone knows how to fix it so this is not required please let me know\n\n## Contribution\nPlease submit issues/pull requests if there is something missing, documentation inaccuracy, or a revision\nI am trying to keep this as up to date as possible to help in mod development\n\nAny and all work on this is appreciated! \n\nFor a list of functions missing documetation: [Missing Functions](missing_functions.md)\n\n## References\n#### Thank yous/Credits:\n[rikby/ac-stubs](https://github.com/rikby/ac-stubs) - These guys did a bunch of the heavy lifting by getting all the function stubs. I just modified it and documented it. The only reason why this repository exists is that its been over a year since that repository was updated and I saw that there was still room to imporve on it and with the pull request I made remaing open, I decided to create this to continue its inital purpose by helping modders when it comes to IDE intellisense\n\n#### Source documents:\n- https://docs.google.com/document/d/13trBp6K1TjWbToUQs_nfFsB291-zVJzRZCNaTYt4Dzc/pub\n- https://assettocorsamods.net/attachments/inofficial_acpythondoc_v2-pdf.7415/\n- https://www.assettocorsa.net/forum/index.php?threads/python-doc-update-25-05-2017.517/\n\n#### Initial forum threads:\n- https://assettocorsamods.net/threads/doc-python-doc.59\n- https://assettocorsamods.net/threads/is-there-a-way-to-load-ac-library-to-have-autocomplete-in-an-ide-e-g-pycharm.3088/\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Assetto Corsa intellisense stubs helper",
    "version": "1.1.1",
    "project_urls": null,
    "split_keywords": [
        "python",
        " ac",
        " assetto corsa",
        " dummy",
        " stub"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a18999ea8c3d3e56f25c56df2ecc319d812d2987725604426d534e3875ff7af6",
                "md5": "54f18fbf868f2e96c61fbd985b97d65a",
                "sha256": "f2904414e823492c3443d9690a9718603e45336bd73f46c30d8398954710e243"
            },
            "downloads": -1,
            "filename": "acintellisense-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "54f18fbf868f2e96c61fbd985b97d65a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 17389,
            "upload_time": "2024-10-16T20:09:35",
            "upload_time_iso_8601": "2024-10-16T20:09:35.610289Z",
            "url": "https://files.pythonhosted.org/packages/a1/89/99ea8c3d3e56f25c56df2ecc319d812d2987725604426d534e3875ff7af6/acintellisense-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8e17d6afd6e76190701288ecc93a81166d2c101a1bb646a62b075ffe5e5281b5",
                "md5": "3bdd9c728272b957b7f36a6e8c8c337a",
                "sha256": "106c01fa4b944cead2f8eb830885567358ae923f4dc54388e37dc687b9cc95d7"
            },
            "downloads": -1,
            "filename": "acintellisense-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3bdd9c728272b957b7f36a6e8c8c337a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 18281,
            "upload_time": "2024-10-16T20:09:36",
            "upload_time_iso_8601": "2024-10-16T20:09:36.856008Z",
            "url": "https://files.pythonhosted.org/packages/8e/17/d6afd6e76190701288ecc93a81166d2c101a1bb646a62b075ffe5e5281b5/acintellisense-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-16 20:09:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "acintellisense"
}
        
Elapsed time: 3.50853s