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

Rename module pyglm #264

Merged
merged 2 commits into from
Nov 24, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ include setup.py
include setup.cfg
include VERSION
include glm/py.typed
recursive-include PyGLM-stubs *
recursive-include pyglm-stubs *
recursive-include PyGLM_lib *
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ At the same time, it has **great performance**, usually being **a lot faster tha

It can be installed from the [PyPI](https://pypi.python.org/pypi/PyGLM) using [pip](https://pip.pypa.io/en/stable/):
``` batch
pip install PyGLM
pip install pyglm
```
And finally imported and used:
``` python
from PyGLM import glm
from pyglm import glm
```
*Changed in version 2\.8*
When using PyGLM version *2\.7\.3* or earlier, use
``` python
try:
from PyGLM import glm
from pyglm import glm
except ImportError:
import glm
```
Expand Down Expand Up @@ -102,7 +102,7 @@ You will find an overview on the \[[Passing data to external libs](https://githu
Most likely you've installed [glm](https://pypi.org/project/glm/), a JSON parser and not [PyGLM](https://pypi.org/project/PyGLM/) \(or a very early version of PyGLM\)\.
The correct install command is:
``` batch
pip install PyGLM
pip install pyglm
```

#### Why is *<experimental extension name here>* not supported?
Expand All @@ -112,7 +112,7 @@ I try adding them on a one\-by\-one basis\.

### Short example
``` Python
from PyGLM import glm
from pyglm import glm

# Create a 3D vector
v1 = glm.vec3(1, 2, 3)
Expand Down
10 changes: 5 additions & 5 deletions README.sb
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ At the same time, it has \b \great performance\ b\, usually being \b \a lot fast

It can be installed from the \url https://pypi.python.org/pypi/PyGLM \PyPI\ url\ using \url https://pip.pypa.io/en/stable/ \pip\ url\:
\code batch\
pip install PyGLM
pip install pyglm
\ code\
And finally imported and used:
\code python \
from PyGLM import glm
from pyglm import glm
\ code\
\i\Changed in version 2.8\i\
When using PyGLM version \i \2.7.3\ i\ or earlier, use
\code python \
try:
from PyGLM import glm
from pyglm import glm
except ImportError:
import glm
\ code\
Expand Down Expand Up @@ -100,7 +100,7 @@ You will find an overview on the [\url https://github.com/Zuzu-Typ/PyGLM/wiki/Pa
Most likely you've installed \url https://pypi.org/project/glm/ \glm\ url\, a JSON parser and not \url https://pypi.org/project/PyGLM/ \PyGLM\ url\ (or a very early version of PyGLM).
The correct install command is:
\code batch \
pip install PyGLM
pip install pyglm
\ code\

\h4\Why is \i\<experimental extension name here>\i\ not supported?\h4\
Expand All @@ -110,7 +110,7 @@ I try adding them on a one-by-one basis.

\h3 \Short example\ h3\
\code Python \
from PyGLM import glm
from pyglm import glm

# Create a 3D vector
v1 = glm.vec3(1, 2, 3)
Expand Down
6 changes: 3 additions & 3 deletions glm/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from PyGLM.glm import *
from PyGLM import glm_typing, typing
from pyglm.glm import *
from pyglm import glm_typing, typing

import warnings as __warnings

__warnings.warn("Importing PyGLM via \"import glm\" is going to be deprecated in the future.\nUse \"from PyGLM import glm\" instead", PendingDeprecationWarning)
__warnings.warn("Importing PyGLM via \"import glm\" is going to be deprecated in the future.\nUse \"from pyglm import glm\" instead", PendingDeprecationWarning)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[metadata]
name = PyGLM
name = pyglm
version = file: VERSION
author = Zuzu_Typ
author_email = [email protected]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
setup(
ext_modules=[
Extension(
name="PyGLM.glm",
name="pyglm.glm",
sources=["PyGLM_lib/PyGLM.cpp"],
include_dirs=["PyGLM_lib/glm/"],
extra_compile_args=['-std=c++11', f'-DVERSION={VERSION}']
Expand Down