etrade-python 1.0.0__tar.gz

etrade_python-1.0.0/.env.example

@@ -0,0 +1,6 @@
+# Fake examples only. Copy to .env and load explicitly with _env_file=".env".
+ETRADE_CONSUMER_KEY=fake-sandbox-key
+ETRADE_CONSUMER_SECRET=fake-sandbox-secret
+ETRADE_ENVIRONMENT=sandbox
+ETRADE_REQUEST_TIMEOUT_SECONDS=30
+ETRADE_INACTIVITY_BUFFER_SECONDS=300

etrade_python-1.0.0/.gitignore

@@ -0,0 +1,18 @@
+__pycache__/
+*.py[cod]
+.venv/
+.env
+.env.*
+!.env.example
+*credentials*.json
+*.pem
+.pytest_cache/
+.ruff_cache/
+.coverage*
+htmlcov/
+coverage.xml
+dist/
+build/
+*.egg-info/
+.idea/
+docs/

etrade_python-1.0.0/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+## Unreleased — planned 1.0.0
+
+### Added
+
+- Async-first Python 3.11+ client with a shared injectable HTTPX transport and
+  namespaced Accounts, Portfolio, Transactions, Market, Orders, and Alerts services.
+- Typed Pydantic request and response models, Decimal monetary values, and
+  standard-library date and datetime values. Unknown response fields are discarded.
+- Account listing and balances; portfolio positions and lots; transaction history
+  and details; quotes, product lookup, option expirations, and option chains.
+- Order listing, separate preview and placement operations, change previews,
+  change placement, and cancellation, with validated requests and an order builder.
+- Alert listing, details, and deletion.
+- OAuth 1.0a signing, browser authorization, token exchange, renewal, and revocation;
+  automatic inactivity renewal and daily expiration handling.
+- Pluggable memory and system-keyring credential stores with isolation by
+  environment, consumer-key fingerprint, and profile.
+- Diagnostic Typer CLI and interactive orders demo with quote-based price estimates,
+  chain-based strike selection, and paginated expiration selection.
+- Structured exceptions, sanitized parser diagnostics, conservative retry policy,
+  and operational logging without credentials or signed headers.
+- Offline unit and HTTP contract tests, lint and type checks, coverage enforcement,
+  wheel/source builds, and CI across Python 3.11–3.14.
+- Stable-release workflow with version/tag checks, clean distribution installation
+  checks, and PyPI Trusted Publishing through the GitHub `pypi` environment.
+
+### Fixed
+
+- Preserve transaction continuation markers, default sorting to DESC, and remove
+  duplicate boundary transactions during automatic pagination. Automatic transaction
+  pagination requires a page count of at least two.
+- Follow portfolio page numbers and order continuation markers without stopping
+  prematurely; detect repeated continuation values.
+- Accept Python field names as well as broker aliases in request models, and type
+  documented Portfolio, Quote, and Orders response fields.
+- Parse supported broker timezone labels and offsets; reject invalid timestamps
+  with sanitized errors instead of silently discarding them.
+- Validate order actions, quantities, option contracts, required prices, and
+  integer identifiers; support the documented EXTO market session.
+- Reject unexpected response shapes and order mutation responses missing valid
+  confirmation identifiers.
+- Correct the iron-condor estimate's credit/debit sign, make the monthly expiration
+  default visible and selectable, and allow safely encoded multiword product lookups.
+
+### Security
+
+- Hide authorization URLs in ordinary model representations and redact individual
+  OAuth header values, including encoded and decoded forms, from error diagnostics.
+- Reject non-2xx OAuth responses without following redirects or reporting renewal
+  or revocation success.
+- Make explicit renewal contact the broker and record ordinary token usage only
+  after completed 2xx exchanges. Preserve newer timestamps and ignore late responses
+  for deleted or replaced credentials within a session manager.
+- Leave legacy profile-only credential entries untouched and require a new login;
+  their environment and consumer ownership cannot be verified.

etrade_python-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing
+
+Use Python 3.11+ and uv. Runtime network code must be async, typed, and use the
+shared request pipeline. Keep API services independent of application frameworks.
+
+## Development workflow
+
+Run from the repository root:
+
+```sh
+make install
+make check
+make package-check
+```
+
+`make install` creates or synchronizes the virtual environment with development
+dependencies. `make check` runs Ruff lint and formatting checks, Pyright, and
+pytest. `make package-check` builds the wheel and source distribution and checks
+package metadata with Twine.
+
+Use `make format` to apply formatting. Individual checks are available through
+`make lint`, `make format-check`, `make type`, and `make test`.
+
+If you need to recreate the environment, `make venv-reset` deletes `.venv`, creates
+it with Python 3.12, and reinstalls dependencies. This does not change the library's
+Python 3.11+ requirement.
+
+## Implementation and tests
+
+Review the official E*TRADE specification before changing endpoint behavior.
+Document the intended public Python API in the pull request and implement it
+independently; do not mechanically translate reference implementation code.
+Update the README coverage table when endpoint support or verification changes.
+Public contributions must not depend on unpublished local documentation.
+
+Use HTTPX MockTransport at the HTTP boundary for contract tests, exercising
+request serialization and response parsing into typed models. Keep tests offline
+and use fake credentials and customer data. Pin clocks in time-dependent tests.
+Follow the provenance and maintenance guidance in [tests/fixtures/README.md](tests/fixtures/README.md)
+when adding or converting fixtures.
+
+Coverage includes statements and branches; the configured combined threshold is
+90%. Pytest excludes `sandbox` and `production` markers by default. No live
+integration tests are currently included. Any future live tests must be explicitly
+selected, and production tests must be read-only by default. Never place trades
+in ordinary CI.
+
+Test pagination, validation, credential redaction, and retry behavior when changing
+those features. Order mutations must not acquire automatic retries.
+
+## Package verification and releases
+
+After `make package-check`, verify installation outside the source checkout in a
+separate environment:
+
+```sh
+wheel_check_dir="$(mktemp -d)"
+uv venv --python 3.12 "$wheel_check_dir"
+uv pip install --python "$wheel_check_dir/bin/python" dist/*.whl
+(cd /tmp && "$wheel_check_dir/bin/python" -c 'import etrade_python; print(etrade_python.__version__)')
+(cd /tmp && "$wheel_check_dir/bin/etrade" --version)
+```
+
+
+Contributions are licensed under Apache-2.0. Do not add personal account details,
+.env files, live recordings, or credentials. Document the origin and permissions
+for reused fixtures or examples; use synthetic data for new security scenarios.

etrade_python-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.