typstwriter


Nametypstwriter JSON
Version 0.2 PyPI version JSON
download
home_pageNone
SummaryAn integrated editor for the typst typesetting system.
upload_time2024-08-16 15:17:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords typst
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ![Typstwriter](docs/logo/Typstwriter_Text_Compact_asPath.svg)

An integrated editor for the [typst](https://github.com/typst/typst) typesetting system.

![](docs/screenshots/overview.png)

## Features

* Integrated Document Viewer
* Integrated File System viewer
* Syntax highlighting

## Configuration

Typstwriter can be configured using a configuration file, see [example_config.ini](docs/example_config.ini) for an example config file. After modifying the config file, typstwriter needs to be restarted.

Typstwriter looks for configuration files in the following locations:

* /etc/typstwriter/typstwriter.ini
* /usr/local/etc/typstwriter/typstwriter.ini
* ~/.config/typstwriter/typstwriter.ini
* ~/.typstwriter.ini
* ./typstwriter.ini

Files further down in the list will take precedence.

## Installation

### Using pip:

Typstwriter is available on [PyPI](https://pypi.org/project/typstwriter/). To install using `pip` simply use:

```
pip install typstwriter
```

### From source

Get the source code by cloning the desired branch or download a release from th github repository and install from the toplevel directory:

```
git clone https://github.com/Bzero/typstwriter
pip install ./typstwriter/
```

### Install typst
Independently of the installation method chosen, the `typst` CLI has to be available to compile typst documents. Consult the [typst repository](https://github.com/typst/typst#installation) for details on installing `typst`. Alternatively, the path of a `typst` executable can be specified in the [configuration file](#Configuration).

## Development

Clone the repository

```
git clone https://github.com/Bzero/typstwriter/
```

Install typstwriter in edit mode

```
pip install -e ./typstwriter/
```

Run the tests with pytest to make sure that everything is working correctly. Inside the source directory, run:

```
pytest
```

Activate pre-commit hooks to automatically check changes before committing. Inside the source directory, run:

```
pre-commit install
```

## Contributing

Contributions are always welcome!

* Open an [Issue](https://github.com/Bzero/typstwriter/issues) to report bugs or request features.
* Use the [discussion](https://github.com/Bzero/typstwriter/discussions) to give feedback.
* Send a [Pull request](https://github.com/Bzero/typstwriter/pulls) to propose new features.

## License

Typstwriter is licensed under the [MIT license](LICENSE). 

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "typstwriter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "typst",
    "author": null,
    "author_email": "Bzero <B_0@posteo.net>",
    "download_url": "https://files.pythonhosted.org/packages/41/51/b4158d65164b44b5b1b0dc34e7782bdc4ae317512e09beedf36ca1c090a5/typstwriter-0.2.tar.gz",
    "platform": null,
    "description": "# ![Typstwriter](docs/logo/Typstwriter_Text_Compact_asPath.svg)\n\nAn integrated editor for the [typst](https://github.com/typst/typst) typesetting system.\n\n![](docs/screenshots/overview.png)\n\n## Features\n\n* Integrated Document Viewer\n* Integrated File System viewer\n* Syntax highlighting\n\n## Configuration\n\nTypstwriter can be configured using a configuration file, see [example_config.ini](docs/example_config.ini) for an example config file. After modifying the config file, typstwriter needs to be restarted.\n\nTypstwriter looks for configuration files in the following locations:\n\n* /etc/typstwriter/typstwriter.ini\n* /usr/local/etc/typstwriter/typstwriter.ini\n* ~/.config/typstwriter/typstwriter.ini\n* ~/.typstwriter.ini\n* ./typstwriter.ini\n\nFiles further down in the list will take precedence.\n\n## Installation\n\n### Using pip:\n\nTypstwriter is available on [PyPI](https://pypi.org/project/typstwriter/). To install using `pip` simply use:\n\n```\npip install typstwriter\n```\n\n### From source\n\nGet the source code by cloning the desired branch or download a release from th github repository and install from the toplevel directory:\n\n```\ngit clone https://github.com/Bzero/typstwriter\npip install ./typstwriter/\n```\n\n### Install typst\nIndependently of the installation method chosen, the `typst` CLI has to be available to compile typst documents. Consult the [typst repository](https://github.com/typst/typst#installation) for details on installing `typst`. Alternatively, the path of a `typst` executable can be specified in the [configuration file](#Configuration).\n\n## Development\n\nClone the repository\n\n```\ngit clone https://github.com/Bzero/typstwriter/\n```\n\nInstall typstwriter in edit mode\n\n```\npip install -e ./typstwriter/\n```\n\nRun the tests with pytest to make sure that everything is working correctly. Inside the source directory, run:\n\n```\npytest\n```\n\nActivate pre-commit hooks to automatically check changes before committing. Inside the source directory, run:\n\n```\npre-commit install\n```\n\n## Contributing\n\nContributions are always welcome!\n\n* Open an [Issue](https://github.com/Bzero/typstwriter/issues) to report bugs or request features.\n* Use the [discussion](https://github.com/Bzero/typstwriter/discussions) to give feedback.\n* Send a [Pull request](https://github.com/Bzero/typstwriter/pulls) to propose new features.\n\n## License\n\nTypstwriter is licensed under the [MIT license](LICENSE). \n",
    "bugtrack_url": null,
    "license": null,
    "summary": "An integrated editor for the typst typesetting system.",
    "version": "0.2",
    "project_urls": {
        "Repository": "https://github.com/Bzero/typstwriter"
    },
    "split_keywords": [
        "typst"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f62b4a12a5854183eb1580f9e64f53e98bb49a47209fd3e2a4ed0ff2a88b102c",
                "md5": "270571de61a209c246a3388eb3eedbca",
                "sha256": "47759204180e26a5a80e4fa7a3dfe5c42812c436b49327914caa0f5415d3a5f1"
            },
            "downloads": -1,
            "filename": "typstwriter-0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "270571de61a209c246a3388eb3eedbca",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 72221,
            "upload_time": "2024-08-16T15:17:42",
            "upload_time_iso_8601": "2024-08-16T15:17:42.352889Z",
            "url": "https://files.pythonhosted.org/packages/f6/2b/4a12a5854183eb1580f9e64f53e98bb49a47209fd3e2a4ed0ff2a88b102c/typstwriter-0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4151b4158d65164b44b5b1b0dc34e7782bdc4ae317512e09beedf36ca1c090a5",
                "md5": "fb4f89f45600e5ac78c44431a6cca984",
                "sha256": "3254c4e74976e1319a99a7a28825d4989d223625969f90adbd0c42ad206caf8a"
            },
            "downloads": -1,
            "filename": "typstwriter-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "fb4f89f45600e5ac78c44431a6cca984",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 807245,
            "upload_time": "2024-08-16T15:17:45",
            "upload_time_iso_8601": "2024-08-16T15:17:45.939442Z",
            "url": "https://files.pythonhosted.org/packages/41/51/b4158d65164b44b5b1b0dc34e7782bdc4ae317512e09beedf36ca1c090a5/typstwriter-0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-16 15:17:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Bzero",
    "github_project": "typstwriter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "typstwriter"
}
        
Elapsed time: 1.19172s