Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README.md, and add badges. #404

Merged
merged 4 commits into from
Dec 28, 2022
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 33 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,45 @@
comtypes
========
# comtypes

**comtypes** is a lightweight Python COM package, based on the ctypes_
FFI library, in less than 10000 lines of code (not counting the
tests).
[![PyPI version](https://badge.fury.io/py/comtypes.svg)](https://pypi.org/project/comtypes/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/comtypes)](https://pypi.org/project/comtypes/) [![PyPI - License](https://img.shields.io/pypi/l/comtypes)](https://pypi.org/project/comtypes/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/comtypes)](https://pypi.org/project/comtypes/)
[![GitHub Repo stars](https://img.shields.io/github/stars/enthought/comtypes?style=social)](https://github.com/enthought/comtypes/stargazers) [![GitHub forks](https://img.shields.io/github/forks/enthought/comtypes?style=social)](https://github.com/enthought/comtypes/network/members)

**comtypes** allows to define, call, and implement custom and
dispatch-based COM interfaces in pure Python. It works on Windows and
64-bit Windows. Windows CE support was dropped since comtypes==1.1.8.
## About

Documentation:
`comtypes` is a lightweight `Python` COM package, based on the [`ctypes`](https://docs.python.org/library/ctypes.html) FFI library.

https://pythonhosted.org/comtypes
`comtypes` allows to define, call, and implement custom and dispatch-based COM interfaces in pure `Python`.

Contribute using the `source repository and issue tracker
<https://github.com/enthought/comtypes/>`_ on GitHub.
This package works on only Windows.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar: it should be on Windows only

- [`comtypes==1.1.7`](https://pypi.org/project/comtypes/1.1.7/) is the last version of supporting Windows CE.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-> the last version supporting Windows CE


Mailing list:
## Where to get it

http://gmane.org/info.php?group=gmane.comp.python.comtypes.user
The source code is currently hosted on GitHub at:
https://github.com/enthought/comtypes

https://lists.sourceforge.net/lists/listinfo/comtypes-users/
Binary installers for the latest released version are available at the [Python Package Index (PyPI)](https://pypi.org/project/comtypes).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does it mean "binary" for source only package? Do you mean wheel packages? I'd suggest to leave just An installer for the latest released version is ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have seen packages that use this wording (such as pandas) and I thought it may be customary in Python communities.

Your suggestion is more straightforward, so I will change it to that.


Download:
```sh
# PyPI
pip install comtypes
```

Releases can be downloaded in the PyPI page:
## Dependencies

https://pypi.python.org/pypi/comtypes
`comtypes` requires no third-party packages to run - this is truly **pure** `Python` package.

.. _ctypes: http://docs.python.org/lib/module-ctypes.html
Optional features include the follows...
- to process arrays as `numpy`'s `ndarray`
- type hints be interpreted by `mypy` or several static type checkers

But these third-parties are not required as a prerequisite for runtime.

## Community of the developers

Tracking issues, reporting bugs and contributing to the codebase and documentation are on GitHub at:
https://github.com/enthought/comtypes

## Documentation:

The documentation is currently hosted on pythonhosted at:
https://pythonhosted.org/comtypes