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 #1230

Merged
merged 10 commits into from
Dec 13, 2024
Merged

📝 Update README #1230

merged 10 commits into from
Dec 13, 2024

Conversation

ff137
Copy link
Collaborator

@ff137 ff137 commented Dec 11, 2024

  • Fixes Codacy badge links
  • Updates "under development" note
  • Add more badges

@ff137
Copy link
Collaborator Author

ff137 commented Dec 11, 2024

@rblaine95 What do you think about adding badges that show Mise / Tilt compatibility?

e.g. one of:

Mise:
Mise
Mise
Mise

Tilt:
Tilt
Tilt
Tilt


Edit - more:
Toolset: Mise
Dev Experience: Tilt
Workflow: Tilt

@ff137
Copy link
Collaborator Author

ff137 commented Dec 11, 2024

Here's the current new badges I'm thinking to add:
image

Some other options, thanks to GPT:
build status, last release date, supported platforms, dependency management tool, "actively maintained" status
(most of those are already visible on the page)

@wdbasson @cl0ete Let me know what you think!

Less is more, but more is also more

@ff137 ff137 added the documentation Improvements or additions to documentation label Dec 11, 2024
@ff137
Copy link
Collaborator Author

ff137 commented Dec 11, 2024

Also, considering that acapy is no longer "aries cloud agent", thought we can rename the project to didx-cloud. Just in the readme title for now, and repo rename next year

Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%119–120
app/models
   wallet.py36489%100–105
app/routes
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
   credentials.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
   acapy_ledger.py611280%110–111, 124–140, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1663579%118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 174, 228–229, 256
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py95595%100–102, 276–281
   set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py18856%17–33
   credentials.py14286%13, 18
   retry_method.py361558%20–35, 76–77, 91–103
   save_exchange_record.py13192%29
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14286%34–35
shared
   log_config.py501864%41–88, 97–104, 146, 155–167
shared/models
   connection_record.py24196%47
   credential_exchange.py43784%85–88, 101–104
   endorsement.py856820%36–70, 92–122, 132–179
   presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
   protocol.py10190%18
   trustregistry.py63789%22, 44, 75–83
shared/services
   nats_jetstream.py36489%56, 60, 64, 68
shared/util
   api_router.py14193%17
   mock_agent_controller.py55689%23, 74–78
   rich_async_client.py47491%71–77
trustregistry
   main.py82495%46–48, 110
waypoint
   main.py48198%64
waypoint/services
   nats_service.py109397%69–71
TOTAL493254889% 

Tests Skipped Failures Errors Time
888 6 💤 0 ❌ 0 🔥 3m 34s ⏱️

Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%119–120
app/models
   wallet.py36489%100–105
app/routes
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
   credentials.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
   acapy_ledger.py611969%43–49, 79, 110–111, 124–140, 146–149, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1664672%118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 174, 228–229, 256
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py95595%100–102, 276–281
   set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py181233%14–34
   check_endorser_connection.py10460%14–24
   credentials.py14286%13, 18
   retry_method.py363017%15–36, 68–114
   save_exchange_record.py13192%29
   string.py15473%15–16, 20, 24
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14750%21–39
shared
   log_config.py501864%41–88, 97–104, 146, 155–167
shared/models
   connection_record.py24196%47
   credential_exchange.py43784%85–88, 101–104
   endorsement.py856820%36–70, 92–122, 132–179
   presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
   protocol.py10190%18
   trustregistry.py63789%22, 44, 75–83
shared/services
   nats_jetstream.py36489%56, 60, 64, 68
shared/util
   api_router.py14193%17
   mock_agent_controller.py55689%23, 74–78
   rich_async_client.py47491%71–77
trustregistry
   main.py82495%46–48, 110
waypoint
   main.py48198%64
waypoint/services
   nats_service.py109397%69–71
TOTAL493259888% 

Tests Skipped Failures Errors Time
888 46 💤 0 ❌ 1 🔥 4m 50s ⏱️

@ff137 ff137 requested a review from rblaine95 December 13, 2024 09:22
Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%119–120
app/models
   wallet.py36489%100–105
app/routes
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
   credentials.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
   acapy_ledger.py611280%110–111, 124–140, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1663579%118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 174, 228–229, 256
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py95595%100–102, 276–281
   set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py18856%17–33
   credentials.py14286%13, 18
   retry_method.py361558%20–35, 76–77, 91–103
   save_exchange_record.py13192%29
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14286%34–35
shared
   log_config.py501864%41–88, 97–104, 146, 155–167
shared/models
   connection_record.py24196%47
   credential_exchange.py43784%85–88, 101–104
   endorsement.py856820%36–70, 92–122, 132–179
   presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
   protocol.py10190%18
   trustregistry.py63789%22, 44, 75–83
shared/services
   nats_jetstream.py36489%56, 60, 64, 68
shared/util
   api_router.py14193%17
   mock_agent_controller.py55689%23, 74–78
   rich_async_client.py47491%71–77
trustregistry
   main.py82495%46–48, 110
waypoint
   main.py48198%64
waypoint/services
   nats_service.py109397%69–71
TOTAL493254889% 

Tests Skipped Failures Errors Time
888 6 💤 0 ❌ 5 🔥 6m 16s ⏱️

Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%119–120
app/models
   wallet.py36489%100–105
app/routes
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
   credentials.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
   acapy_ledger.py611969%43–49, 79, 110–111, 124–140, 146–149, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1664672%118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 174, 228–229, 256
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py95595%100–102, 276–281
   set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py181233%14–34
   check_endorser_connection.py10460%14–24
   credentials.py14286%13, 18
   retry_method.py363017%15–36, 68–114
   save_exchange_record.py13192%29
   string.py15473%15–16, 20, 24
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14750%21–39
shared
   log_config.py501864%41–88, 97–104, 146, 155–167
shared/models
   connection_record.py24196%47
   credential_exchange.py43784%85–88, 101–104
   endorsement.py856820%36–70, 92–122, 132–179
   presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
   protocol.py10190%18
   trustregistry.py63789%22, 44, 75–83
shared/services
   nats_jetstream.py36489%56, 60, 64, 68
shared/util
   api_router.py14193%17
   mock_agent_controller.py55689%23, 74–78
   rich_async_client.py47491%71–77
trustregistry
   main.py82495%46–48, 110
waypoint
   main.py48198%64
waypoint/services
   nats_service.py109397%69–71
TOTAL493259888% 

Tests Skipped Failures Errors Time
888 46 💤 0 ❌ 1 🔥 4m 56s ⏱️

Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%119–120
app/models
   wallet.py36489%100–105
app/routes
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
   credentials.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
   acapy_ledger.py611280%110–111, 124–140, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1663579%118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 174, 228–229, 256
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py95595%100–102, 276–281
   set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py18856%17–33
   credentials.py14286%13, 18
   retry_method.py361558%20–35, 76–77, 91–103
   save_exchange_record.py13192%29
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14286%34–35
shared
   log_config.py501864%41–88, 97–104, 146, 155–167
shared/models
   connection_record.py24196%47
   credential_exchange.py43784%85–88, 101–104
   endorsement.py856820%36–70, 92–122, 132–179
   presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
   protocol.py10190%18
   trustregistry.py63789%22, 44, 75–83
shared/services
   nats_jetstream.py36489%56, 60, 64, 68
shared/util
   api_router.py14193%17
   mock_agent_controller.py55689%23, 74–78
   rich_async_client.py47491%71–77
trustregistry
   main.py82495%46–48, 110
waypoint
   main.py48198%64
waypoint/services
   nats_service.py109397%69–71
TOTAL493254889% 

Tests Skipped Failures Errors Time
888 6 💤 0 ❌ 2 🔥 3m 54s ⏱️

Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%119–120
app/models
   wallet.py36489%100–105
app/routes
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
   credentials.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
   acapy_ledger.py611969%43–49, 79, 110–111, 124–140, 146–149, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1664672%118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 174, 228–229, 256
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py95595%100–102, 276–281
   set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py181233%14–34
   check_endorser_connection.py10460%14–24
   credentials.py14286%13, 18
   retry_method.py363017%15–36, 68–114
   save_exchange_record.py13192%29
   string.py15473%15–16, 20, 24
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14750%21–39
shared
   log_config.py501864%41–88, 97–104, 146, 155–167
shared/models
   connection_record.py24196%47
   credential_exchange.py43784%85–88, 101–104
   endorsement.py856820%36–70, 92–122, 132–179
   presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
   protocol.py10190%18
   trustregistry.py63789%22, 44, 75–83
shared/services
   nats_jetstream.py36489%56, 60, 64, 68
shared/util
   api_router.py14193%17
   mock_agent_controller.py55689%23, 74–78
   rich_async_client.py47491%71–77
trustregistry
   main.py82495%46–48, 110
waypoint
   main.py48198%64
waypoint/services
   nats_service.py109397%69–71
TOTAL493259888% 

Tests Skipped Failures Errors Time
888 46 💤 0 ❌ 1 🔥 4m 56s ⏱️

Copy link
Collaborator

@cl0ete cl0ete left a comment

Choose a reason for hiding this comment

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

🚀

@ff137 ff137 merged commit 04545fe into master Dec 13, 2024
45 of 48 checks passed
@ff137 ff137 deleted the update-readme branch December 13, 2024 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants