JustStream 0.1.30__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- juststream-0.1.30/.distribution-target +1 -0
- juststream-0.1.30/.github/ISSUE_TEMPLATE/01.feature.yml +37 -0
- juststream-0.1.30/.github/ISSUE_TEMPLATE/02.bug.yml +62 -0
- juststream-0.1.30/.github/ISSUE_TEMPLATE/03.fix.yml +55 -0
- juststream-0.1.30/.github/ISSUE_TEMPLATE/04.task.yml +38 -0
- juststream-0.1.30/.github/ISSUE_TEMPLATE/config.yml +1 -0
- juststream-0.1.30/.github/PULL_REQUEST_TEMPLATE.md +24 -0
- juststream-0.1.30/.github/instructions/CODE.instructions.md +32 -0
- juststream-0.1.30/.github/instructions/DOCS.instructions.md +55 -0
- juststream-0.1.30/.github/instructions/README.instructions.md +36 -0
- juststream-0.1.30/.github/scripts/build_distributions.py +76 -0
- juststream-0.1.30/.github/scripts/check_distributions.py +440 -0
- juststream-0.1.30/.github/scripts/create-issues-from-reviews.mjs +564 -0
- juststream-0.1.30/.github/scripts/prepare_upload.py +104 -0
- juststream-0.1.30/.github/scripts/run_core_tests.py +26 -0
- juststream-0.1.30/.github/scripts/tests/__init__.py +0 -0
- juststream-0.1.30/.github/scripts/tests/create-issues-from-reviews.test.mjs +636 -0
- juststream-0.1.30/.github/scripts/tests/test_distributions.py +117 -0
- juststream-0.1.30/.github/scripts/tests/test_release.py +239 -0
- juststream-0.1.30/.github/scripts/tests/test_release_notes.py +101 -0
- juststream-0.1.30/.github/workflows/ci.yml +591 -0
- juststream-0.1.30/.github/workflows/create-issues-from-reviews.yml +55 -0
- juststream-0.1.30/.gitignore +52 -0
- juststream-0.1.30/LICENSE +674 -0
- juststream-0.1.30/PKG-INFO +94 -0
- juststream-0.1.30/README.en.md +75 -0
- juststream-0.1.30/README.md +75 -0
- juststream-0.1.30/README.setup.md +61 -0
- juststream-0.1.30/build/core/JustStream.egg-info/SOURCES.txt +180 -0
- juststream-0.1.30/docs/Contracts.en.md +175 -0
- juststream-0.1.30/docs/Contracts.md +168 -0
- juststream-0.1.30/docs/GettingStarted.en.md +184 -0
- juststream-0.1.30/docs/GettingStarted.md +182 -0
- juststream-0.1.30/docs/LifecycleHooks.en.md +216 -0
- juststream-0.1.30/docs/LifecycleHooks.md +212 -0
- juststream-0.1.30/docs/Operations.en.md +191 -0
- juststream-0.1.30/docs/Operations.md +182 -0
- juststream-0.1.30/docs/Packaging.en.md +86 -0
- juststream-0.1.30/docs/Packaging.md +86 -0
- juststream-0.1.30/docs/README.en.md +39 -0
- juststream-0.1.30/docs/README.md +39 -0
- juststream-0.1.30/docs/RabbitMQ.en.md +510 -0
- juststream-0.1.30/docs/RabbitMQ.md +488 -0
- juststream-0.1.30/docs/Redis.en.md +235 -0
- juststream-0.1.30/docs/Redis.md +230 -0
- juststream-0.1.30/docs/Tasks.en.md +211 -0
- juststream-0.1.30/docs/Tasks.md +207 -0
- juststream-0.1.30/res/.gitkeep +0 -0
- juststream-0.1.30/res/docker/.gitkeep +0 -0
- juststream-0.1.30/res/docker/rabbitmq/README.md +58 -0
- juststream-0.1.30/res/docker/rabbitmq/enabled_plugins +1 -0
- juststream-0.1.30/res/docker/rabbitmq/rabbitmq-3.yml +22 -0
- juststream-0.1.30/res/docker/rabbitmq/rabbitmq-4.yml +22 -0
- juststream-0.1.30/res/docker/redis/README.md +46 -0
- juststream-0.1.30/res/docker/redis/redis-6.yml +14 -0
- juststream-0.1.30/res/docker/redis/redis-7.yml +14 -0
- juststream-0.1.30/samples/Broker/RabbitMQ/Sample.RPC.py +191 -0
- juststream-0.1.30/samples/Broker/RabbitMQ/Sample.Stream.py +98 -0
- juststream-0.1.30/samples/Broker/RabbitMQ/Sample.Timer.py +90 -0
- juststream-0.1.30/samples/Broker/RabbitMQ/Sample.py +150 -0
- juststream-0.1.30/samples/Broker/Redis/Sample.Stream.py +87 -0
- juststream-0.1.30/samples/Broker/Redis/Sample.py +76 -0
- juststream-0.1.30/samples/Broker/Sample.py +268 -0
- juststream-0.1.30/samples/Worker/RabbitMQ/Client.py +85 -0
- juststream-0.1.30/samples/Worker/RabbitMQ/Tasks.py +185 -0
- juststream-0.1.30/samples/Worker/RabbitMQ/Worker.py +128 -0
- juststream-0.1.30/samples/Worker/Redis/Sample.py +188 -0
- juststream-0.1.30/samples/Worker/Sample.py +273 -0
- juststream-0.1.30/setup.cfg +4 -0
- juststream-0.1.30/setup.py +208 -0
- juststream-0.1.30/src/Broker/Configuration.py +17 -0
- juststream-0.1.30/src/Broker/Connection.py +176 -0
- juststream-0.1.30/src/Broker/Consumer.py +59 -0
- juststream-0.1.30/src/Broker/Errors.py +14 -0
- juststream-0.1.30/src/Broker/Event.py +35 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Configuration.py +49 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Connection.py +587 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Consumer.py +420 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Event.py +146 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Exchange.py +277 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Queue.py +321 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Serializer.py +75 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Stream.py +181 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/Subscription.py +90 -0
- juststream-0.1.30/src/Broker/Implements/RabbitMQ/__init__.py +47 -0
- juststream-0.1.30/src/Broker/Implements/Redis/Configuration.py +59 -0
- juststream-0.1.30/src/Broker/Implements/Redis/Connection.py +265 -0
- juststream-0.1.30/src/Broker/Implements/Redis/Consumer.py +368 -0
- juststream-0.1.30/src/Broker/Implements/Redis/Event.py +212 -0
- juststream-0.1.30/src/Broker/Implements/Redis/Queue.py +284 -0
- juststream-0.1.30/src/Broker/Implements/Redis/Serializer.py +48 -0
- juststream-0.1.30/src/Broker/Implements/Redis/Subscription.py +46 -0
- juststream-0.1.30/src/Broker/Implements/Redis/__init__.py +29 -0
- juststream-0.1.30/src/Broker/Implements/__init__.py +5 -0
- juststream-0.1.30/src/Broker/Priority.py +26 -0
- juststream-0.1.30/src/Broker/Protocol.py +54 -0
- juststream-0.1.30/src/Broker/__init__.py +65 -0
- juststream-0.1.30/src/Descriptor/DataObject.py +409 -0
- juststream-0.1.30/src/Descriptor/Types.py +248 -0
- juststream-0.1.30/src/Descriptor/Value.py +188 -0
- juststream-0.1.30/src/Descriptor/__init__.py +172 -0
- juststream-0.1.30/src/Inspector/Extension.py +69 -0
- juststream-0.1.30/src/Inspector/Extensions/Metrics.py +316 -0
- juststream-0.1.30/src/Inspector/Extensions/Ping.py +107 -0
- juststream-0.1.30/src/Inspector/Extensions/Play.html +373 -0
- juststream-0.1.30/src/Inspector/Extensions/Play.py +415 -0
- juststream-0.1.30/src/Inspector/Extensions/Specifications.py +176 -0
- juststream-0.1.30/src/Inspector/Extensions/Status.html +206 -0
- juststream-0.1.30/src/Inspector/Extensions/Status.py +124 -0
- juststream-0.1.30/src/Inspector/Extensions/__init__.py +13 -0
- juststream-0.1.30/src/Inspector/Inspector.py +357 -0
- juststream-0.1.30/src/Inspector/Response.py +14 -0
- juststream-0.1.30/src/Inspector/__init__.py +9 -0
- juststream-0.1.30/src/Validator/Pattern.py +36 -0
- juststream-0.1.30/src/Validator/Patterns/Array.py +30 -0
- juststream-0.1.30/src/Validator/Patterns/Common.py +92 -0
- juststream-0.1.30/src/Validator/Patterns/Compare.py +180 -0
- juststream-0.1.30/src/Validator/Patterns/Condition.py +60 -0
- juststream-0.1.30/src/Validator/Patterns/DataObject.py +93 -0
- juststream-0.1.30/src/Validator/Patterns/DateTime.py +111 -0
- juststream-0.1.30/src/Validator/Patterns/Number.py +43 -0
- juststream-0.1.30/src/Validator/Patterns/Object.py +158 -0
- juststream-0.1.30/src/Validator/Patterns/Size.py +110 -0
- juststream-0.1.30/src/Validator/Patterns/String.py +92 -0
- juststream-0.1.30/src/Validator/Patterns/Type.py +355 -0
- juststream-0.1.30/src/Validator/Patterns/__init__.py +137 -0
- juststream-0.1.30/src/Validator/Validate.py +29 -0
- juststream-0.1.30/src/Validator/Validator.py +30 -0
- juststream-0.1.30/src/Validator/__init__.py +11 -0
- juststream-0.1.30/src/Worker/Executor.py +525 -0
- juststream-0.1.30/src/Worker/Message.py +260 -0
- juststream-0.1.30/src/Worker/Pool.py +282 -0
- juststream-0.1.30/src/Worker/Run.py +357 -0
- juststream-0.1.30/src/Worker/Specification.py +87 -0
- juststream-0.1.30/src/Worker/Startup.py +174 -0
- juststream-0.1.30/src/Worker/Worker.py +571 -0
- juststream-0.1.30/src/Worker/__init__.py +47 -0
- juststream-0.1.30/tests/__init__.py +0 -0
- juststream-0.1.30/tests/_support.py +57 -0
- juststream-0.1.30/tests/_support_inspector.py +228 -0
- juststream-0.1.30/tests/_support_inspector_play.py +289 -0
- juststream-0.1.30/tests/_support_task_messages.py +40 -0
- juststream-0.1.30/tests/rabbitmq/__init__.py +0 -0
- juststream-0.1.30/tests/rabbitmq/test_inspector.py +26 -0
- juststream-0.1.30/tests/rabbitmq/test_inspector_play.py +29 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_broker_methods.py +141 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_integration.py +152 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_logging.py +510 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_priorities.py +445 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_rpc.py +456 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_rpc_integration.py +245 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_timeouts.py +278 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_timers.py +288 -0
- juststream-0.1.30/tests/rabbitmq/test_rabbitmq_worker.py +304 -0
- juststream-0.1.30/tests/rabbitmq/test_specifications.py +106 -0
- juststream-0.1.30/tests/rabbitmq/test_task_messages.py +162 -0
- juststream-0.1.30/tests/rabbitmq/test_task_priorities.py +330 -0
- juststream-0.1.30/tests/redis/__init__.py +0 -0
- juststream-0.1.30/tests/redis/test_inspector.py +23 -0
- juststream-0.1.30/tests/redis/test_inspector_play.py +24 -0
- juststream-0.1.30/tests/redis/test_redis.py +300 -0
- juststream-0.1.30/tests/redis/test_redis_integration.py +328 -0
- juststream-0.1.30/tests/redis/test_redis_logging.py +359 -0
- juststream-0.1.30/tests/redis/test_task_messages.py +201 -0
- juststream-0.1.30/tests/redis/test_task_priorities.py +98 -0
- juststream-0.1.30/tests/test_broker_packaging.py +176 -0
- juststream-0.1.30/tests/test_descriptor.py +547 -0
- juststream-0.1.30/tests/test_inspector.py +692 -0
- juststream-0.1.30/tests/test_inspector_logging.py +204 -0
- juststream-0.1.30/tests/test_inspector_play.py +617 -0
- juststream-0.1.30/tests/test_lifecycle_hooks.py +457 -0
- juststream-0.1.30/tests/test_logging.py +337 -0
- juststream-0.1.30/tests/test_pool_callbacks.py +123 -0
- juststream-0.1.30/tests/test_process_signals.py +188 -0
- juststream-0.1.30/tests/test_protocol_contracts.py +603 -0
- juststream-0.1.30/tests/test_runner_hooks.py +215 -0
- juststream-0.1.30/tests/test_specifications.py +931 -0
- juststream-0.1.30/tests/test_status.py +447 -0
- juststream-0.1.30/tests/test_status_ui.cjs +161 -0
- juststream-0.1.30/tests/test_task_messages.py +533 -0
- juststream-0.1.30/tests/test_validator_patterns.py +62 -0
- juststream-0.1.30/tests/test_worker.py +498 -0
- juststream-0.1.30/tests/test_worker_recovery.py +842 -0
- juststream-0.1.30/tests/test_worker_startup.py +401 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
core
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
name: 기능 제안
|
|
2
|
+
description: 추가하거나 개선할 기능을 제안합니다.
|
|
3
|
+
labels:
|
|
4
|
+
- feature
|
|
5
|
+
body:
|
|
6
|
+
- type: markdown
|
|
7
|
+
attributes:
|
|
8
|
+
value: >
|
|
9
|
+
해결하려는 문제와 제안하는 사용 경험을 중심으로 작성해 주세요.
|
|
10
|
+
- type: textarea
|
|
11
|
+
id: problem
|
|
12
|
+
attributes:
|
|
13
|
+
label: 해결하려는 문제
|
|
14
|
+
description: 현재 어떤 불편이나 제약이 있는지 설명해 주세요.
|
|
15
|
+
validations:
|
|
16
|
+
required: true
|
|
17
|
+
- type: textarea
|
|
18
|
+
id: proposal
|
|
19
|
+
attributes:
|
|
20
|
+
label: 제안하는 해결 방법
|
|
21
|
+
description: 원하는 기능과 기대하는 동작을 설명해 주세요.
|
|
22
|
+
validations:
|
|
23
|
+
required: true
|
|
24
|
+
- type: textarea
|
|
25
|
+
id: alternatives
|
|
26
|
+
attributes:
|
|
27
|
+
label: 고려한 대안
|
|
28
|
+
description: 고려한 다른 방법이나 우회 방법이 있다면 적어 주세요.
|
|
29
|
+
validations:
|
|
30
|
+
required: false
|
|
31
|
+
- type: textarea
|
|
32
|
+
id: additional
|
|
33
|
+
attributes:
|
|
34
|
+
label: 추가 정보
|
|
35
|
+
description: 예제, 참고 자료 등 제안의 맥락을 이해하는 데 도움이 되는 정보를 적어 주세요.
|
|
36
|
+
validations:
|
|
37
|
+
required: false
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
name: 버그/오류 제보
|
|
2
|
+
description: 예상과 다르게 동작하거나 오류가 발생하는 문제를 제보합니다.
|
|
3
|
+
labels:
|
|
4
|
+
- bug
|
|
5
|
+
body:
|
|
6
|
+
- type: markdown
|
|
7
|
+
attributes:
|
|
8
|
+
value: >
|
|
9
|
+
재현 가능한 버그를 제보해 주세요. 로그나 설정을 첨부할 때 토큰, 비밀번호,
|
|
10
|
+
개인정보 등 민감한 정보는 반드시 삭제해 주세요.
|
|
11
|
+
- type: input
|
|
12
|
+
id: version
|
|
13
|
+
attributes:
|
|
14
|
+
label: 버전
|
|
15
|
+
description: 사용 중인 버전 또는 커밋을 입력해 주세요.
|
|
16
|
+
placeholder: 예) 0.1.12
|
|
17
|
+
validations:
|
|
18
|
+
required: true
|
|
19
|
+
- type: textarea
|
|
20
|
+
id: expected
|
|
21
|
+
attributes:
|
|
22
|
+
label: 기대한 동작
|
|
23
|
+
description: 어떤 결과를 기대했는지 설명해 주세요.
|
|
24
|
+
validations:
|
|
25
|
+
required: true
|
|
26
|
+
- type: textarea
|
|
27
|
+
id: actual
|
|
28
|
+
attributes:
|
|
29
|
+
label: 실제 동작
|
|
30
|
+
description: 실제로 발생한 결과를 설명해 주세요. 오류가 표시되면 메시지도 포함해 주세요.
|
|
31
|
+
validations:
|
|
32
|
+
required: true
|
|
33
|
+
- type: textarea
|
|
34
|
+
id: reproduction
|
|
35
|
+
attributes:
|
|
36
|
+
label: 재현 방법
|
|
37
|
+
description: 문제를 재현하는 단계나 최소 코드 예제를 작성해 주세요.
|
|
38
|
+
placeholder: |
|
|
39
|
+
1. 다음 설정으로 Worker를 시작합니다.
|
|
40
|
+
2. 특정 메시지를 전달합니다.
|
|
41
|
+
3. 오류가 발생합니다.
|
|
42
|
+
validations:
|
|
43
|
+
required: true
|
|
44
|
+
- type: textarea
|
|
45
|
+
id: environment
|
|
46
|
+
attributes:
|
|
47
|
+
label: 실행 환경
|
|
48
|
+
description: Python 버전, 운영체제, 브로커 및 관련 어댑터 버전을 입력해 주세요.
|
|
49
|
+
placeholder: |
|
|
50
|
+
- Python:
|
|
51
|
+
- 운영체제:
|
|
52
|
+
- 브로커:
|
|
53
|
+
- 어댑터:
|
|
54
|
+
validations:
|
|
55
|
+
required: true
|
|
56
|
+
- type: textarea
|
|
57
|
+
id: additional
|
|
58
|
+
attributes:
|
|
59
|
+
label: 추가 정보
|
|
60
|
+
description: 관련 로그나 스크린샷 등 문제 파악에 도움이 되는 정보를 적어 주세요.
|
|
61
|
+
validations:
|
|
62
|
+
required: false
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
name: 변경 제안
|
|
2
|
+
description: 일반 변경이나 핫픽스의 목적과 범위를 정리합니다.
|
|
3
|
+
labels:
|
|
4
|
+
- fix
|
|
5
|
+
body:
|
|
6
|
+
- type: markdown
|
|
7
|
+
attributes:
|
|
8
|
+
value: >
|
|
9
|
+
일반 변경이나 긴급 수정이 필요한 핫픽스를 제안할 때 사용해 주세요.
|
|
10
|
+
재현 가능한 기존 결함은 버그/오류 제보 양식을 이용해 주세요.
|
|
11
|
+
- type: dropdown
|
|
12
|
+
id: change_type
|
|
13
|
+
attributes:
|
|
14
|
+
label: 변경 유형
|
|
15
|
+
description: 제안하는 변경의 성격을 선택해 주세요.
|
|
16
|
+
options:
|
|
17
|
+
- 일반 변경
|
|
18
|
+
- 핫픽스
|
|
19
|
+
validations:
|
|
20
|
+
required: true
|
|
21
|
+
- type: textarea
|
|
22
|
+
id: purpose
|
|
23
|
+
attributes:
|
|
24
|
+
label: 변경 목적
|
|
25
|
+
description: 왜 이 변경이 필요한지, 해결하려는 불편이나 상황을 설명해 주세요.
|
|
26
|
+
validations:
|
|
27
|
+
required: true
|
|
28
|
+
- type: textarea
|
|
29
|
+
id: proposed_changes
|
|
30
|
+
attributes:
|
|
31
|
+
label: 제안하는 변경 내용
|
|
32
|
+
description: 무엇을 어떻게 바꾸면 좋을지 적어 주세요.
|
|
33
|
+
validations:
|
|
34
|
+
required: true
|
|
35
|
+
- type: textarea
|
|
36
|
+
id: scope
|
|
37
|
+
attributes:
|
|
38
|
+
label: 영향 범위
|
|
39
|
+
description: 영향을 받는 기능, 사용자, 호환성 또는 설정을 알고 있다면 적어 주세요.
|
|
40
|
+
validations:
|
|
41
|
+
required: false
|
|
42
|
+
- type: textarea
|
|
43
|
+
id: hotfix_context
|
|
44
|
+
attributes:
|
|
45
|
+
label: 긴급 수정 정보
|
|
46
|
+
description: 핫픽스인 경우 긴급한 이유, 영향받는 버전 및 임시 대응 방법을 적어 주세요.
|
|
47
|
+
validations:
|
|
48
|
+
required: false
|
|
49
|
+
- type: textarea
|
|
50
|
+
id: acceptance_criteria
|
|
51
|
+
attributes:
|
|
52
|
+
label: 완료 기준
|
|
53
|
+
description: 변경이 완료되었다고 판단할 수 있는 조건이나 검증 방법을 적어 주세요.
|
|
54
|
+
validations:
|
|
55
|
+
required: false
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: 작업 제안
|
|
2
|
+
description: 리소스 변경, 문서화 등 소스 코드 변경이 아닌 작업을 정리합니다.
|
|
3
|
+
labels:
|
|
4
|
+
- task
|
|
5
|
+
body:
|
|
6
|
+
- type: markdown
|
|
7
|
+
attributes:
|
|
8
|
+
value: >
|
|
9
|
+
리소스 변경, 문서 작성·정리 등 소스 코드를 변경하지 않는 작업에 사용해 주세요.
|
|
10
|
+
기능 추가, 버그 제보 또는 소스 코드 변경은 해당 이슈 양식을 이용해 주세요.
|
|
11
|
+
- type: textarea
|
|
12
|
+
id: purpose
|
|
13
|
+
attributes:
|
|
14
|
+
label: 작업 목적
|
|
15
|
+
description: 이 작업이 필요한 이유와 기대하는 효과를 설명해 주세요.
|
|
16
|
+
validations:
|
|
17
|
+
required: true
|
|
18
|
+
- type: textarea
|
|
19
|
+
id: scope
|
|
20
|
+
attributes:
|
|
21
|
+
label: 작업 내용 및 대상
|
|
22
|
+
description: 수행할 작업과 대상 리소스, 문서 또는 경로를 적어 주세요.
|
|
23
|
+
validations:
|
|
24
|
+
required: true
|
|
25
|
+
- type: textarea
|
|
26
|
+
id: acceptance_criteria
|
|
27
|
+
attributes:
|
|
28
|
+
label: 완료 기준
|
|
29
|
+
description: 작업이 완료되었다고 판단할 수 있는 결과물이나 확인 방법을 적어 주세요.
|
|
30
|
+
validations:
|
|
31
|
+
required: true
|
|
32
|
+
- type: textarea
|
|
33
|
+
id: additional
|
|
34
|
+
attributes:
|
|
35
|
+
label: 관련 자료 및 주의사항
|
|
36
|
+
description: 참고 링크, 관련 이슈, 사전 준비나 주의사항이 있다면 적어 주세요.
|
|
37
|
+
validations:
|
|
38
|
+
required: false
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
blank_issues_enabled: false
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
## 변경 내용
|
|
2
|
+
|
|
3
|
+
<!-- 무엇을 왜 변경했는지 간단히 요약해 주세요. -->
|
|
4
|
+
|
|
5
|
+
## 변경 유형
|
|
6
|
+
|
|
7
|
+
- [ ] 버그 수정 및 일반 변경, 핫픽스 처리
|
|
8
|
+
- [ ] 기능 추가
|
|
9
|
+
- [ ] 호환성에 영향을 주는 변경
|
|
10
|
+
- [ ] 문서 또는 예제 변경
|
|
11
|
+
- [ ] 기타
|
|
12
|
+
|
|
13
|
+
## 검증
|
|
14
|
+
|
|
15
|
+
<!-- 실행한 테스트와 결과를 작성해 주세요. 테스트를 실행하지 않았다면 사유를 적어 주세요. -->
|
|
16
|
+
|
|
17
|
+
- [ ] 관련 테스트를 실행했습니다.
|
|
18
|
+
- [ ] 문서와 예제를 확인했습니다.
|
|
19
|
+
|
|
20
|
+
## 확인 사항
|
|
21
|
+
|
|
22
|
+
- [ ] 변경 범위가 요청 사항에 한정되어 있습니다.
|
|
23
|
+
- [ ] 공개 API나 기존 동작에 영향을 주는 경우 변경 내용과 마이그레이션 방법을 설명했습니다.
|
|
24
|
+
- [ ] 민감 정보나 불필요한 디버깅 코드를 포함하지 않았습니다.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "JustStream 소스코드의 독스트링·주석·예외 메시지·로그 등 개발자와 사용자에게 전달되는 문구의 영어 작성 지침"
|
|
3
|
+
applyTo: "**/*.py"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# JustStream 소스코드 작성 지침
|
|
7
|
+
|
|
8
|
+
## 목적과 적용 범위
|
|
9
|
+
|
|
10
|
+
JustStream은 한국어 사용자뿐 아니라 전 세계 사용자를 대상으로 한다. 소스코드를 읽거나 실행 결과를 접하는 사용자가 공통으로 이해할 수 있도록 코드 안의 설명과 진단 문구는 영어로 작성한다.
|
|
11
|
+
|
|
12
|
+
프로젝트의 Python 소스, 테스트, 샘플과 보조 스크립트를 작성·수정할 때 적용한다. 다른 언어의 소스를 다루는 경우에도 같은 언어 정책을 따른다.
|
|
13
|
+
|
|
14
|
+
## 코드 내 언어 정책
|
|
15
|
+
|
|
16
|
+
- 모듈·클래스·함수·메소드의 독스트링은 영어로 작성한다.
|
|
17
|
+
- 주석과 TODO 설명은 영어로 작성한다. 언어 규칙을 적용하기 위해 불필요한 주석이나 독스트링을 추가하지 않는다.
|
|
18
|
+
- 예외를 발생시킬 때의 오류 메시지, 경고, 로그, CLI 도움말과 사용 안내 등 프로젝트가 생성하는 진단 문구는 영어로 작성한다.
|
|
19
|
+
- 샘플의 설명용 출력과 테스트 실패 시 제공하는 설명 문구도 영어로 작성한다.
|
|
20
|
+
- API·식별자·패키지 이름·프로토콜 용어는 원래 표기와 저장소 명명 규칙을 유지한다.
|
|
21
|
+
|
|
22
|
+
## 예외와 다른 지침의 관계
|
|
23
|
+
|
|
24
|
+
- 국제화·인코딩·다국어 처리를 검증하는 테스트 데이터, 사용자 입력과 원문 보존이 필요한 외부 자료까지 영어로 바꾸지는 않는다.
|
|
25
|
+
- 명시적으로 현지화하는 콘텐츠는 해당 언어·번역 계약을 따른다. 라이브러리 진단 문구와 사용자가 제공하는 메시지를 구분한다.
|
|
26
|
+
- 이 프로젝트의 코드 내 문구에는 공통 지침의 한국어 독스트링·주석 작성 규칙 대신 이 영어 정책을 적용한다.
|
|
27
|
+
- 이 지침 문서와 개발 과정의 사용자 설명은 한국어로 작성한다. README·매뉴얼 등 독립 문서의 언어는 해당 문서 지침을 따른다.
|
|
28
|
+
|
|
29
|
+
## 변경과 검증
|
|
30
|
+
|
|
31
|
+
- 새로 작성하거나 변경하는 코드 내 문구에 이 정책을 적용한다. 별도 요청 없이 기존 코드 전체를 일괄 번역하지 않는다.
|
|
32
|
+
- 기존 오류 문구를 바꿀 때는 메시지를 확인하는 테스트와 관련 문서를 함께 검토한다. 예외 타입, 오류 코드와 기존 동작을 번역 목적으로 바꾸지 않는다.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "JustStream 상세 매뉴얼 작성 지침"
|
|
3
|
+
applyTo: "docs/**/*.md"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# JustStream 상세 매뉴얼 작성 지침
|
|
7
|
+
|
|
8
|
+
## 디렉터리와 진입 문서
|
|
9
|
+
|
|
10
|
+
- 상세 매뉴얼은 저장소 루트의 `docs/`에 둔다.
|
|
11
|
+
- 상세 매뉴얼은 한국어를 기준 문서 언어로 작성하고 영어판도 함께 제공한다. `docs/README.md`는 한국어 진입점이며, `docs/README.en.md`는 그에 대응하는 영어 진입점이다. 두 문서는 주제별 안내와 목차를 동일한 범위로 제공한다.
|
|
12
|
+
- 각 영어판 파일은 한국어 파일과 같은 이름에 `.en.md`를 붙인다. 예를 들어 `README.md`의 영어판은 `README.en.md`, `broker.md`의 영어판은 `broker.en.md`다. 한국어 문서를 추가하거나 분리할 때 대응하는 영어 문서도 함께 작성하고, 구조와 내용을 일치시켜 서로 연결한다.
|
|
13
|
+
- 처음에는 `docs/README.md`에 내용을 작성한다. 문서가 길어져 탐색이나 유지보수가 어려워지면 독립된 주제 단위로 Markdown 파일을 분리한다.
|
|
14
|
+
- 문서를 분리할 때는 한국어·영어 진입 문서 모두에 각 문서가 다루는 내용의 짧은 설명과 상대 링크를 추가한다. 양쪽 언어에서 주제 구성을 동등하게 탐색할 수 있도록 한다.
|
|
15
|
+
- 아직 작성하지 않은 주제의 빈 문서나 형식적인 목차 항목을 미리 만들지 않는다.
|
|
16
|
+
|
|
17
|
+
## 대상 독자와 설명 방식
|
|
18
|
+
|
|
19
|
+
- 초보 학생도 따라올 수 있도록 기본 개념부터 차근차근 설명한다. 생소한 용어와 약어는 처음 등장할 때 쉬운 말로 풀어 쓴다.
|
|
20
|
+
- 개념과 절차는 작은 단계로 나누고, 필요한 사전 지식이나 실행 환경을 먼저 밝힌다. 독자가 앞선 단계를 완료했는지 확인할 수 있도록 실행 결과나 확인 방법을 제시한다.
|
|
21
|
+
- 예제 코드는 개념을 설명하는 데 도움이 되는 범위에서 가능한 한 충분히 제공한다. 짧은 코드 조각만으로 이해하기 어려운 경우 전체 실행 흐름이 보이는 예제를 우선한다.
|
|
22
|
+
- 예제에는 필요한 import, 설정, 실행 방법과 기대 결과를 포함한다. 생략한 부분이나 자리표시자는 명확히 표시하고 완성된 실행 예제로 오해되지 않게 한다.
|
|
23
|
+
- 예제 수를 늘리기 위해 중복되거나 실제 학습에 도움이 되지 않는 코드를 반복하지 않는다. 모든 예제는 현재 공개 API와 호환되고 복사해 실행할 수 있는지 확인한다.
|
|
24
|
+
- 기초 사용법에서 시작해 선택 설정과 고급 운영으로 이어지도록 주제와 설명 순서를 구성한다.
|
|
25
|
+
- 요청 처리 흐름, 작업 생명주기, 구성 요소 관계처럼 시각화가 이해에 도움이 되는 주제에는 Mermaid 다이어그램을 적극적으로 활용한다. 문서 주제에 맞는 흐름도, 시퀀스 다이어그램, 상태도 또는 구성도 등을 선택하고, 필요한 곳에는 다이어그램을 충분히 제공한다.
|
|
26
|
+
- Mermaid는 `mermaid` 코드 펜스로 작성한다. 노드 이름과 화살표의 방향·관계는 실제 동작과 일치시킨다.
|
|
27
|
+
- 다이어그램만으로 중요한 절차나 계약을 설명하지 않는다. 초보자가 그림을 읽을 수 있도록 앞뒤 문장에서 의미와 핵심 흐름을 설명한다.
|
|
28
|
+
- 한국어·영어 문서에 같은 다이어그램을 제공할 때 노드 문구는 해당 문서 언어로 작성하되 구조와 의미는 일치시킨다.
|
|
29
|
+
- 이해에 도움이 되지 않는 장식용 다이어그램은 추가하지 않고, 복잡해진 다이어그램은 이해 가능한 단위로 나눈다.
|
|
30
|
+
|
|
31
|
+
## 기술 내용의 정확성
|
|
32
|
+
|
|
33
|
+
- 내용은 JustStream의 공개 API, 구현된 동작과 지원되는 설정에 근거한다.
|
|
34
|
+
- 작업 정의, 구독·ACK·실패 처리, 실행 풀과 종료, 생명주기 훅, 요청·응답 계약, Inspector, 로깅, RabbitMQ 및 Redis Streams 안내는 해당 기능의 실제 계약을 확인해 작성한다.
|
|
35
|
+
- 설정 예시와 코드 샘플은 현재 API와 호환되어야 한다. 외부 브로커나 서비스가 필요한 절차에는 요구 사항과 실행 조건을 설명한다.
|
|
36
|
+
- 지원 여부가 확인되지 않은 기능, 보장되지 않는 동작, 실제 수행하지 않은 검증을 사실처럼 작성하지 않는다.
|
|
37
|
+
- 사용자에게 필요한 제약, 오류 동작, 호환성 또는 운영상 주의사항을 해당 주제에서 설명한다.
|
|
38
|
+
|
|
39
|
+
## 작업 완료 시 매뉴얼 갱신
|
|
40
|
+
|
|
41
|
+
- 모든 작업을 마치고 이슈별 변경 로그를 작성하기 전, 변경된 기능·사용법·설정·제약을 상세 매뉴얼에 반영해야 하는지 반드시 검토한다.
|
|
42
|
+
- 사용자에게 영향을 주는 공개 기능, 동작, API, 설정, 설치·운영 절차, 오류 또는 제약이 바뀌면 관련 `docs/` 상세 매뉴얼을 같은 작업에서 갱신한다. 새 동작에 맞는 예제와 Mermaid 다이어그램도 필요한지 확인한다.
|
|
43
|
+
- 한국어 매뉴얼을 갱신하면 대응하는 `.en.md` 영어판도 함께 갱신한다. 변경 로그 작성만으로 매뉴얼 갱신을 대신하지 않는다.
|
|
44
|
+
- 기존 매뉴얼에 관련 내용이 없으면 필요한 주제별 문서를 만들고, 한국어·영어 진입 문서 양쪽에서 연결한다.
|
|
45
|
+
- 문서 영향이 없는 내부 변경은 매뉴얼 내용을 억지로 추가하지 않는다. 완료 전 영향 검토를 수행하고, 문서 변경이 불필요한 이유를 작업 기록에 남긴다.
|
|
46
|
+
- 변경 로그를 작성한 뒤 변경 로그에 적은 사용자 영향과 상세 매뉴얼이 일치하는지 최종 확인한다.
|
|
47
|
+
|
|
48
|
+
## 문서 구성과 유지보수
|
|
49
|
+
|
|
50
|
+
- 제목은 문서의 주제를 명확히 나타내고, 한 문서는 하나의 주요 주제를 다룬다.
|
|
51
|
+
- 같은 상세 설명을 여러 문서에 복제하지 않는다. 기준 문서에 내용을 두고 다른 곳에서는 상대 링크로 연결한다.
|
|
52
|
+
- `README.md` 및 `README.en.md`에는 상세 설명을 복제하지 않고 `docs/README.md`로 안내한다. 공개 API나 사용법에 영향이 있는 변경이면 관련 루트 README 요약도 함께 검토한다.
|
|
53
|
+
- 예제에는 필요한 전제 조건을 표시하고 비밀값이나 실제 자격 증명을 넣지 않는다.
|
|
54
|
+
- 한국어·영어 매뉴얼을 함께 갱신해 기능, 예제 및 제약 설명이 어긋나지 않게 한다.
|
|
55
|
+
- 공통 마크다운 작성 지침을 따르며, 내부 링크와 앵커가 실제 문서 구조에 맞는지 확인한다.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "JustStream 프로젝트 루트 README 작성 지침"
|
|
3
|
+
applyTo: "README*.md"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# JustStream 루트 README 작성 지침
|
|
7
|
+
|
|
8
|
+
## 문서별 역할
|
|
9
|
+
|
|
10
|
+
- `README.md`는 한국어로 JustStream을 소개하고 핵심 사용 정보를 안내한다.
|
|
11
|
+
- `README.en.md`는 `README.md`와 주요 기능, 설치 및 빠른 시작 범위를 맞춘 영어 문서다. 공개 기능이나 사용법을 변경하면 두 문서를 함께 갱신한다.
|
|
12
|
+
- `README.setup.md`는 패키지 저장소에서 독립적으로 읽을 수 있는 간결한 영어 설명이다. 프로젝트 소개, Python 요구 사항, 설치 방법과 최소 빠른 시작을 포함한다.
|
|
13
|
+
- 이 지침은 루트의 세 README에만 적용한다. 상세 사용 설명과 주제별 매뉴얼은 `.instructions/DOCS.instructions.md`의 지침에 따라 `docs/`에 작성한다.
|
|
14
|
+
|
|
15
|
+
## README에 포함할 정보
|
|
16
|
+
|
|
17
|
+
- 프로젝트의 목적과 핵심 기능을 실제 구현에 근거해 간결하게 설명한다.
|
|
18
|
+
- 지원 Python 버전, 설치 방법과 선택 가능한 RabbitMQ·Redis extra를 정확히 안내한다.
|
|
19
|
+
- 처음 사용할 수 있는 최소 빠른 시작 예제를 포함하고, 필요한 브로커 실행 등 전제 조건을 설명한다.
|
|
20
|
+
- 루트의 `README.md`와 `README.en.md`에서 상세 매뉴얼의 진입점인 `docs/README.md`로 연결한다. 링크 문구는 문서 언어에 맞추고 쉽게 찾을 수 있게 배치한다.
|
|
21
|
+
- 루트 README에는 상세 매뉴얼 전체를 복사하지 않는다. 자세한 API, 설정, 브로커별 운영법과 추가 사례는 `docs/`로 안내한다.
|
|
22
|
+
|
|
23
|
+
## 버전 및 변경 이력
|
|
24
|
+
|
|
25
|
+
- `README.md`와 `README.en.md`에서 최신 릴리즈와 전체 변경 이력을 확인할 수 있도록 JustStream 릴리즈 페이지로 연결한다.
|
|
26
|
+
- 릴리즈마다 수동 갱신이 필요한 버전 번호를 문서에 중복 기록하지 않는다. 버전을 표시해야 하면 릴리즈 기준 정보와 자동으로 동기화되는 방법을 사용한다.
|
|
27
|
+
- 주요 변경 사항을 루트 README에 소개할 필요가 있으면 핵심만 요약하고, 전체 이력은 릴리즈 페이지를 기준으로 한다.
|
|
28
|
+
- `README.setup.md`는 외부 URL이나 외부 웹 페이지 링크를 포함하지 않는다. 따라서 릴리즈 페이지 링크도 넣지 않는다.
|
|
29
|
+
|
|
30
|
+
## 정확성 및 표현
|
|
31
|
+
|
|
32
|
+
- 공개 기능, 지원 범위, 동작과 제약은 JustStream의 현재 코드와 설정에 맞게 작성한다. 확인하지 않은 보장이나 기능을 추가하지 않는다.
|
|
33
|
+
- 코드 예제와 import 경로는 현재 공개 API를 사용하고, 설치 명령과 extra 이름은 패키지 설정과 일치시킨다.
|
|
34
|
+
- RabbitMQ와 Redis Streams는 선택 의존성임을 분명히 하고, 실제 브로커가 필요한 예제에는 전제 조건을 표시한다.
|
|
35
|
+
- README의 문서 언어에 맞춰 자연스럽게 작성하고, 기술 식별자와 공개 API 이름은 원문을 유지한다.
|
|
36
|
+
- 기존 공통 마크다운 지침을 따른다. `README.setup.md`에 대해서는 외부 링크 금지를 우선 적용한다.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
from argparse import ArgumentParser
|
|
2
|
+
from os import environ
|
|
3
|
+
from pathlib import Path
|
|
4
|
+
from subprocess import run
|
|
5
|
+
from sys import executable
|
|
6
|
+
|
|
7
|
+
PROJECT = 'JustStream'
|
|
8
|
+
IMPLEMENTATIONS = {
|
|
9
|
+
'RabbitMQ': 'Broker.Implements.RabbitMQ',
|
|
10
|
+
'Redis': 'Broker.Implements.Redis',
|
|
11
|
+
}
|
|
12
|
+
ROOT = Path(__file__).resolve().parents[2]
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def main() -> None:
|
|
16
|
+
from setuptools_scm import get_version
|
|
17
|
+
|
|
18
|
+
parser = ArgumentParser(description='Build the core and implementation distributions.')
|
|
19
|
+
parser.add_argument(
|
|
20
|
+
'--outdir',
|
|
21
|
+
default='dist',
|
|
22
|
+
)
|
|
23
|
+
parser.add_argument(
|
|
24
|
+
'--wheel',
|
|
25
|
+
action='store_true',
|
|
26
|
+
)
|
|
27
|
+
parser.add_argument(
|
|
28
|
+
'--no-isolation',
|
|
29
|
+
action='store_true',
|
|
30
|
+
)
|
|
31
|
+
options = parser.parse_args()
|
|
32
|
+
environment: dict[str, str] = dict(environ)
|
|
33
|
+
environment['SETUPTOOLS_SCM_PRETEND_VERSION'] = get_version(
|
|
34
|
+
root=str(ROOT),
|
|
35
|
+
dist_name=PROJECT,
|
|
36
|
+
tag_regex=r'^v?(?P<version>[0-9]+\.[0-9]+\.[0-9]+(?:\.[0-9]+)?(?:(?:rc|\.post)[0-9]+)?)$',
|
|
37
|
+
# changes/<SHA> 릴리스 노트 태그가 버전 태그로 해석되지 않도록 버전 형태의 태그만 조회
|
|
38
|
+
git_describe_command=[
|
|
39
|
+
'git',
|
|
40
|
+
'describe',
|
|
41
|
+
'--dirty',
|
|
42
|
+
'--tags',
|
|
43
|
+
'--long',
|
|
44
|
+
'--match',
|
|
45
|
+
'[0-9]*.[0-9]*',
|
|
46
|
+
'--match',
|
|
47
|
+
'v[0-9]*.[0-9]*',
|
|
48
|
+
],
|
|
49
|
+
)
|
|
50
|
+
for target in (
|
|
51
|
+
'core',
|
|
52
|
+
*IMPLEMENTATIONS,
|
|
53
|
+
):
|
|
54
|
+
environment['DEF_BUILD_TARGET'] = target
|
|
55
|
+
command = [
|
|
56
|
+
executable,
|
|
57
|
+
'-m',
|
|
58
|
+
'build',
|
|
59
|
+
'--outdir',
|
|
60
|
+
str(Path(options.outdir).resolve()),
|
|
61
|
+
]
|
|
62
|
+
if options.wheel:
|
|
63
|
+
command.append('--wheel')
|
|
64
|
+
if options.no_isolation:
|
|
65
|
+
command.append('--no-isolation')
|
|
66
|
+
run(
|
|
67
|
+
command,
|
|
68
|
+
cwd=ROOT,
|
|
69
|
+
env=environment,
|
|
70
|
+
check=True,
|
|
71
|
+
)
|
|
72
|
+
return
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
if __name__ == '__main__':
|
|
76
|
+
main()
|