Skip to content

Commit

Permalink
rename proj
Browse files Browse the repository at this point in the history
  • Loading branch information
ikvk committed Aug 24, 2022
1 parent 9d3b120 commit 12dcc68
Show file tree
Hide file tree
Showing 11 changed files with 47 additions and 47 deletions.
34 changes: 17 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. http://docutils.sourceforge.net/docs/user/rst/quickref.html
pyecs 🚀
========
ecs_pattern 🚀
==============

Implementation of the ECS template for creating games. Make a game instead of architecture for a game.

`Документация на русском <https://github.com/ikvk/pyecs/blob/master/_docs/README_RUS.rst>`_.
`Документация на русском <https://github.com/ikvk/ecs_pattern/blob/master/_docs/README_RUS.rst>`_.

.. image:: https://img.shields.io/pypi/dm/pyecs.svg?style=social
.. image:: https://img.shields.io/pypi/dm/ecs_pattern.svg?style=social

=============== =====================================
=============== ==========================================
Python version 3.5+
License Apache-2.0
PyPI https://pypi.python.org/pypi/pyecs/
=============== =====================================
PyPI https://pypi.python.org/pypi/ecs_pattern/
=============== ==========================================

Intro
-----
Expand All @@ -34,17 +34,17 @@ Installation
------------
::

$ pip install pyecs
$ pip install ecs-pattern

Guide to pyecs
--------------
Guide
-----

**Component**
| Property with object data. Contains only data, no logic.
| The component is used as a mixin in entities.
| Use the pyecs.component decorator to create components:
| Use the ecs_pattern.component decorator to create components:
.. code-block:: python
Expand All @@ -63,7 +63,7 @@ Guide to pyecs
| It is forbidden to add attributes to an entity dynamically.
| Use the pyecs.entity decorator to create entities:
| Use the ecs_pattern.entity decorator to create entities:
.. code-block:: python
Expand All @@ -80,7 +80,7 @@ Guide to pyecs
| Does not contain data about entities and components.
| Use the pyecs.System abstract class to create concrete systems:
| Use the ecs_pattern.System abstract class to create concrete systems:
.. code-block:: python
Expand Down Expand Up @@ -112,7 +112,7 @@ Guide to pyecs
| A single point of access to all entities.
| Use the pyecs.EntityManager class to create systems.
| Use the ecs_pattern.EntityManager class to create systems.
| *entities.add* - add entities.
Expand All @@ -139,7 +139,7 @@ Guide to pyecs
| Works with systems in a given order.
| Use the pyecs.SystemManager class to manage systems.
| Use the ecs_pattern.SystemManager class to manage systems.
| *system_manager.start_systems* - initialize systems. Call once before the main systems update cycle.
Expand All @@ -160,7 +160,7 @@ Guide to pyecs
Examples
--------
* `Pong game: pygame + pyecs <https://github.com/ikvk/pyecs/tree/master/examples/pong>`_.
* `Pong game: pygame + ecs-pattern <https://github.com/ikvk/ecs_pattern/tree/master/examples/pong>`_.

Advantages
----------
Expand Down Expand Up @@ -199,7 +199,7 @@ Good Practices
Releases
--------

History of important changes: `release_notes.rst <https://github.com/ikvk/pyecs/blob/master/_docs/release_notes.rst>`_
History of important changes: `release_notes.rst <https://github.com/ikvk/ecs_pattern/blob/master/_docs/release_notes.rst>`_

Help the project
----------------
Expand Down
32 changes: 16 additions & 16 deletions _docs/README_RUS.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
.. http://docutils.sourceforge.net/docs/user/rst/quickref.html
pyecs 🚀
========
ecs_pattern 🚀
==============

Реализация шаблона ECS для создания игр. Делайте игру вместо архитектуры для игры.

.. image:: https://img.shields.io/pypi/dm/pyecs.svg?style=social
.. image:: https://img.shields.io/pypi/dm/ecs_pattern.svg?style=social

=============== =====================================
=============== ==========================================
Python version 3.5+
License Apache-2.0
PyPI https://pypi.python.org/pypi/pyecs/
=============== =====================================
PyPI https://pypi.python.org/pypi/ecs_pattern/
=============== ==========================================

Введение
--------
Expand All @@ -32,17 +32,17 @@ PyPI https://pypi.python.org/pypi/pyecs/
---------
::

$ pip install pyecs
$ pip install ecs-pattern

Руководство к pyecs
-------------------
Руководство
-----------

**Component**
| Свойство с данными объекта. Содержат только данные, без логики.
| Компонент используется как миксин в сущностях.
| Используйте декоратор pyecs.component для создания компонентов:
| Используйте декоратор ecs_pattern.component для создания компонентов:
.. code-block:: python
Expand All @@ -61,7 +61,7 @@ PyPI https://pypi.python.org/pypi/pyecs/
| Запрещено добавлять атрибуты к сущности динамически.
| Используйте декоратор pyecs.entity для создания сущностей:
| Используйте декоратор ecs_pattern.entity для создания сущностей:
.. code-block:: python
Expand All @@ -78,7 +78,7 @@ PyPI https://pypi.python.org/pypi/pyecs/
| Не содержит данных о сущностях и компонентах.
| Используйте абстрактный класс pyecs.System для создания конкретных систем:
| Используйте абстрактный класс ecs_pattern.System для создания конкретных систем:
.. code-block:: python
Expand Down Expand Up @@ -110,7 +110,7 @@ PyPI https://pypi.python.org/pypi/pyecs/
| Единая точка доступа ко всем сущностям.
| Используйте класс pyecs.EntityManager для создания систем.
| Используйте класс ecs_pattern.EntityManager для создания систем.
| *entities.add* - добавить сущности.
Expand All @@ -137,7 +137,7 @@ PyPI https://pypi.python.org/pypi/pyecs/
| Работает с системами в заданном порядке.
| Используйте класс pyecs.SystemManager для управления системами.
| Используйте класс ecs_pattern.SystemManager для управления системами.
| *system_manager.start_systems* - инициализировать системы. Вызовите один раз перед главным циклом обновления систем.
Expand All @@ -158,7 +158,7 @@ PyPI https://pypi.python.org/pypi/pyecs/
Примеры
-------
* `Игра Pong: pygame + pyecs <https://github.com/ikvk/pyecs/tree/master/examples/pong>`_.
* `Игра Pong: pygame + ecs-pattern <https://github.com/ikvk/ecs_pattern/tree/master/examples/pong>`_.

Преимущества
------------
Expand Down Expand Up @@ -197,7 +197,7 @@ PyPI https://pypi.python.org/pypi/pyecs/
Релизы
------

История важных изменений: `release_notes.rst <https://github.com/ikvk/pyecs/blob/master/_docs/release_notes.rst>`_
История важных изменений: `release_notes.rst <https://github.com/ikvk/ecs_pattern/blob/master/_docs/release_notes.rst>`_

Помощь проекту
--------------
Expand Down
10 changes: 5 additions & 5 deletions _docs/packaging_notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ https://packaging.python.org/tutorials/packaging-projects/
https://docs.python.org/3/distutils/packageindex.html#pypirc

2. Install/update build libs:
C:\python\venv\pyecs310\Scripts\pip install --upgrade -r C:\kvk\develop\Python\pyecs\_docs\build-requirements.txt
C:\python\venv\ecs_pattern310\Scripts\pip install --upgrade -r C:\kvk\develop\Python\ecs_pattern\_docs\build-requirements.txt

3. Generating distribution archives
cd C:\kvk\develop\Python\pyecs\
C:\python\venv\pyecs310\Scripts\python.exe C:\kvk\develop\Python\pyecs\setup.py sdist bdist_wheel
cd C:\kvk\develop\Python\ecs_pattern\
C:\python\venv\ecs_pattern310\Scripts\python.exe C:\kvk\develop\Python\ecs_pattern\setup.py sdist bdist_wheel

4. Check the distribution archives:
C:\python\venv\pyecs310\Scripts\python.exe -m twine check dist/*
C:\python\venv\ecs_pattern310\Scripts\python.exe -m twine check dist/*

5. Uploading the distribution archives:
C:\python\venv\pyecs310\Scripts\python.exe -m twine upload dist/*
C:\python\venv\ecs_pattern310\Scripts\python.exe -m twine upload dist/*
2 changes: 1 addition & 1 deletion pyecs/__init__.py → ecs_pattern/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Lib author: Vladimir Kaukin <KaukinVK@ya.ru>
# Project home page: https://github.com/ikvk/pyecs
# Project home page: https://github.com/ikvk/ecs_pattern
# License: Apache-2.0

from .ecs import component, entity, EntityManager, System, SystemManager
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion examples/pong/components.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from pygame.sprite import Sprite
from pyecs import component
from ecs_pattern import component

from consts import Team

Expand Down
2 changes: 1 addition & 1 deletion examples/pong/entities.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from pyecs import entity
from ecs_pattern import entity

from components import ComMotion, ComScore, ComTeam, ComVisible, ComWait

Expand Down
2 changes: 1 addition & 1 deletion examples/pong/main.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import os

import pygame
from pyecs import EntityManager, SystemManager
from ecs_pattern import EntityManager, SystemManager

from consts import FPS_MAX
from entities import GameStateInfo
Expand Down
2 changes: 1 addition & 1 deletion examples/pong/systems.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from pygame.event import Event
from pygame.display import Info as VideoInfo
from pygame.locals import QUIT, KEYDOWN, KEYUP, K_ESCAPE, K_UP, K_DOWN, K_w, K_s, K_SPACE
from pyecs import System, EntityManager
from ecs_pattern import System, EntityManager

from components import ComMotion, ComVisible
from entities import Ball, GameStateInfo, Racket, Score, Table, TeamScoredGoalEvent, WaitForBallMoveEvent, Spark
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ def get_version(package: str) -> str:
long_description = fh.read()

setuptools.setup(
name='pyecs',
version=get_version('pyecs'),
name='ecs-pattern',
version=get_version('ecs_pattern'),
packages=setuptools.find_packages(exclude=['tests']),
url='https://github.com/ikvk/pyecs',
url='https://github.com/ikvk/ecs_pattern',
license='Apache-2.0',
long_description=long_description,
long_description_content_type="text/x-rst",
Expand Down
2 changes: 1 addition & 1 deletion tests/test_ecs.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import unittest

from pyecs.ecs import component, entity, EntityManager, System, SystemManager
from ecs_pattern import component, entity, EntityManager, System, SystemManager


@component
Expand Down

0 comments on commit 12dcc68

Please sign in to comment.